VipPlanPublishedPayload `vip.plan.published@1`

Generated at 2026-09-23 23:26:36 UTC from openvibe-contracts v0.33.0 and openvibe-sdk v0.5.0.

Version: 1.0.0
Owner: vip
Visibility: public
Status: active
Compatibility: backward
Decision: ADR-012
Schema: https://openvibe.network/contracts/events/payloads/vip.plan.published.v1.json

vip.plan.published v1 (OpenVibe.VIP server/domain/plans.js emitPublished). A plan version became what new members buy: the plan was published, or a published plan was edited (a new immutable version). Carries the version's full terms, never a price (Billing prices and charges). Envelope: subject { type: plan, id: vpl_…, revision: <version> }, visibility public, priority important, actor service:vip.

Fields

Field	Type	Required	Description	Constraints
`plan_id`	string	yes		`pattern ^vpl_[0-9A-HJKMNP-TV-Z]{26}$`
`slug`	string	yes		`pattern ^[a-z0-9][a-z0-9-]{0,47}$`
`version`	integer	yes		`minimum 1`
`version_id`	string	yes		`pattern ^vpv_[0-9A-HJKMNP-TV-Z]{26}$`
`creator`	object	yes		`no other fields`
`creator.id`	string	yes	vcr_… or network.
`creator.kind`	enum	yes		`one of "creator", "network"`
`creator.subject`	one of	yes	null for the network creator.
`creator.username`	string \| null	yes
`creator.display_name`	string \| null	yes
`creator.bio`	string \| null	yes
`creator.status`	enum	yes		`one of "active", "suspended"`
`billing_kind`	enum	yes	The Billing product that sells it; null for a plan Billing does not sell (network plans).	`one of "channel_subscription", null`
`terms`	object	yes		`no other fields`
`terms.name`	string	yes
`terms.description`	string \| null	yes
`terms.benefits`	array \| null	yes		`maxItems 20`
`terms.perks`	array of object	yes		`items: no other fields`
`terms.perks[].key`	string	yes
`terms.perks[].name`	string	yes
`terms.perks[].kind`	enum	yes		`one of "badge", "emote", "gated_content", "room", "role", "other"`
`terms.perks[].scope`	enum	yes		`one of "creator", "network"`
`terms.billing_kind`	enum	yes		`one of "channel_subscription", null`
`terms.price`	string \| null	yes	Never an amount: a note that Billing sets and charges the price, or null.
`terms.digest`	string	yes	sha256 prefix of name, description, benefits, perks and billing_kind.	`pattern ^[0-9a-f]{16}$`
`published_at`	string	yes		`format date-time`

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: channel-plan

{
  "plan_id": "vpl_01JAB3C4D5E6F7G8H9J0K1MNPV",
  "slug": "supporters",
  "version": 2,
  "version_id": "vpv_01JAB3C4D5E6F7G8H9J0K1MNPW",
  "creator": {
    "id": "vcr_01JAB3C4D5E6F7G8H9J0K1MNPX",
    "kind": "creator",
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "japaneseoldguy",
    "display_name": "JapaneseOldGuy",
    "bio": null,
    "status": "active"
  },
  "billing_kind": "channel_subscription",
  "terms": {
    "name": "Supporters",
    "description": "Back the channel.",
    "benefits": [
      "Sub badge",
      "Emote-only chat"
    ],
    "perks": [
      {
        "key": "badge",
        "name": "Sub badge",
        "kind": "badge",
        "scope": "creator"
      }
    ],
    "billing_kind": "channel_subscription",
    "price": "set and charged by OpenVibe.Billing",
    "digest": "3f9a0c1d2e4b5a67"
  },
  "published_at": "2026-09-23T10:00:00.000Z"
}

Valid: network-plan

{
  "plan_id": "vpl_01JAB3C4D5E6F7G8H9J0K1MNPV",
  "slug": "supporters",
  "version": 2,
  "version_id": "vpv_01JAB3C4D5E6F7G8H9J0K1MNPW",
  "creator": {
    "id": "network",
    "kind": "network",
    "subject": null,
    "username": null,
    "display_name": "OpenVibe",
    "bio": null,
    "status": "active"
  },
  "billing_kind": null,
  "terms": {
    "name": "Supporters",
    "description": "Back the channel.",
    "benefits": null,
    "perks": [],
    "billing_kind": null,
    "price": null,
    "digest": "3f9a0c1d2e4b5a67"
  },
  "published_at": "2026-09-23T10:00:00.000Z"
}

Rejected: price-in-terms

{
  "plan_id": "vpl_01JAB3C4D5E6F7G8H9J0K1MNPV",
  "slug": "supporters",
  "version": 2,
  "version_id": "vpv_01JAB3C4D5E6F7G8H9J0K1MNPW",
  "creator": {
    "id": "vcr_01JAB3C4D5E6F7G8H9J0K1MNPX",
    "kind": "creator",
    "subject": {
      "type": "user",
      "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
    },
    "username": "japaneseoldguy",
    "display_name": "JapaneseOldGuy",
    "bio": null,
    "status": "active"
  },
  "billing_kind": "channel_subscription",
  "terms": {
    "name": "Supporters",
    "description": "Back the channel.",
    "benefits": [
      "Sub badge",
      "Emote-only chat"
    ],
    "perks": [
      {
        "key": "badge",
        "name": "Sub badge",
        "kind": "badge",
        "scope": "creator"
      }
    ],
    "billing_kind": "channel_subscription",
    "price": "set and charged by OpenVibe.Billing",
    "digest": "3f9a0c1d2e4b5a67",
    "price_cents": 499
  },
  "published_at": "2026-09-23T10:00:00.000Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('vip.plan.published@1', value);   // { valid, errors: [{ path, message }] }

VipPlanPublishedPayload vip.plan.published@1

Fields

Examples

Validate

VipPlanPublishedPayload `vip.plan.published@1`