VipPlanResult vip.plan-result@1

Generated at from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version
1.0.0
Owner
vip
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/vip/plan-result.v1.json

vip.plan-result@1: answers about one plan on OpenVibe.VIP (vip.plan.create, vip.plan.update, vip.plan.archive). POST /api/v1/plans (201) and POST /api/v1/plans/:id/archive → { plan }; PATCH /api/v1/plans/:id → { plan, version, unchanged } (version: the version written, or the latest when unchanged); POST /api/v1/plans/:id/publish → { plan, replay } (replay: it was already published). The plan carries its creator.

Fields

This schema has no named fields.

Examples

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

Valid: created
{
  "plan": {
    "id": "vpl_01JAB2C3D4E5F6G7H8J9K0MNPW",
    "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "slug": "supporter",
    "status": "published",
    "billing_kind": "channel_subscription",
    "purchasable": true,
    "current_version": {
      "id": "vpv_01JAB2C3D4E5F6G7H8J9K0MNPT",
      "version": 2,
      "name": "Supporter",
      "description": "Back the stream every month.",
      "benefits": [
        "Supporter badge in chat",
        "Members-only VOD chapters"
      ],
      "perks": [
        {
          "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNPV",
          "key": "chat-badge",
          "name": "Chat badge"
        }
      ],
      "terms": {
        "name": "Supporter",
        "description": "Back the stream every month.",
        "benefits": [
          "Supporter badge in chat",
          "Members-only VOD chapters"
        ],
        "perks": [
          {
            "key": "chat-badge",
            "name": "Chat badge",
            "kind": "badge",
            "scope": "creator"
          }
        ],
        "billing_kind": "channel_subscription",
        "price": "set and charged by OpenVibe.Billing",
        "digest": "3fa9c0d27e5b8814"
      },
      "change_note": "added VOD chapters",
      "created_at": "2026-09-20T18:04:11.402Z",
      "published_at": "2026-09-20T18:04:11.402Z"
    },
    "draft_version": null,
    "created_at": "2026-09-20T18:04:11.402Z",
    "updated_at": "2026-09-20T18:04:11.402Z",
    "archived_at": null,
    "creator": {
      "id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "kind": "creator",
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "username": "moosefan",
      "display_name": "Moose Fan",
      "bio": "Late-night builds and chill.",
      "status": "active"
    }
  }
}
Valid: edited
{
  "plan": {
    "id": "vpl_01JAB2C3D4E5F6G7H8J9K0MNPW",
    "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "slug": "supporter",
    "status": "published",
    "billing_kind": "channel_subscription",
    "purchasable": true,
    "current_version": {
      "id": "vpv_01JAB2C3D4E5F6G7H8J9K0MNPT",
      "version": 2,
      "name": "Supporter",
      "description": "Back the stream every month.",
      "benefits": [
        "Supporter badge in chat",
        "Members-only VOD chapters"
      ],
      "perks": [
        {
          "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNPV",
          "key": "chat-badge",
          "name": "Chat badge"
        }
      ],
      "terms": {
        "name": "Supporter",
        "description": "Back the stream every month.",
        "benefits": [
          "Supporter badge in chat",
          "Members-only VOD chapters"
        ],
        "perks": [
          {
            "key": "chat-badge",
            "name": "Chat badge",
            "kind": "badge",
            "scope": "creator"
          }
        ],
        "billing_kind": "channel_subscription",
        "price": "set and charged by OpenVibe.Billing",
        "digest": "3fa9c0d27e5b8814"
      },
      "change_note": "added VOD chapters",
      "created_at": "2026-09-20T18:04:11.402Z",
      "published_at": "2026-09-20T18:04:11.402Z"
    },
    "draft_version": null,
    "created_at": "2026-09-20T18:04:11.402Z",
    "updated_at": "2026-09-20T18:04:11.402Z",
    "archived_at": null,
    "creator": {
      "id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "kind": "creator",
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "username": "moosefan",
      "display_name": "Moose Fan",
      "bio": "Late-night builds and chill.",
      "status": "active"
    }
  },
  "version": {
    "id": "vpv_01JAB2C3D4E5F6G7H8J9K0MNPT",
    "version": 2,
    "name": "Supporter",
    "description": "Back the stream every month.",
    "benefits": [
      "Supporter badge in chat",
      "Members-only VOD chapters"
    ],
    "perks": [
      {
        "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNPV",
        "key": "chat-badge",
        "name": "Chat badge"
      }
    ],
    "terms": {
      "name": "Supporter",
      "description": "Back the stream every month.",
      "benefits": [
        "Supporter badge in chat",
        "Members-only VOD chapters"
      ],
      "perks": [
        {
          "key": "chat-badge",
          "name": "Chat badge",
          "kind": "badge",
          "scope": "creator"
        }
      ],
      "billing_kind": "channel_subscription",
      "price": "set and charged by OpenVibe.Billing",
      "digest": "3fa9c0d27e5b8814"
    },
    "change_note": "added VOD chapters",
    "created_at": "2026-09-20T18:04:11.402Z",
    "published_at": "2026-09-20T18:04:11.402Z"
  },
  "unchanged": false
}
Valid: published
{
  "plan": {
    "id": "vpl_01JAB2C3D4E5F6G7H8J9K0MNPW",
    "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "slug": "supporter",
    "status": "published",
    "billing_kind": "channel_subscription",
    "purchasable": true,
    "current_version": {
      "id": "vpv_01JAB2C3D4E5F6G7H8J9K0MNPT",
      "version": 2,
      "name": "Supporter",
      "description": "Back the stream every month.",
      "benefits": [
        "Supporter badge in chat",
        "Members-only VOD chapters"
      ],
      "perks": [
        {
          "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNPV",
          "key": "chat-badge",
          "name": "Chat badge"
        }
      ],
      "terms": {
        "name": "Supporter",
        "description": "Back the stream every month.",
        "benefits": [
          "Supporter badge in chat",
          "Members-only VOD chapters"
        ],
        "perks": [
          {
            "key": "chat-badge",
            "name": "Chat badge",
            "kind": "badge",
            "scope": "creator"
          }
        ],
        "billing_kind": "channel_subscription",
        "price": "set and charged by OpenVibe.Billing",
        "digest": "3fa9c0d27e5b8814"
      },
      "change_note": "added VOD chapters",
      "created_at": "2026-09-20T18:04:11.402Z",
      "published_at": "2026-09-20T18:04:11.402Z"
    },
    "draft_version": null,
    "created_at": "2026-09-20T18:04:11.402Z",
    "updated_at": "2026-09-20T18:04:11.402Z",
    "archived_at": null,
    "creator": {
      "id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "kind": "creator",
      "subject": {
        "type": "user",
        "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
      },
      "username": "moosefan",
      "display_name": "Moose Fan",
      "bio": "Late-night builds and chill.",
      "status": "active"
    }
  },
  "replay": true
}
Rejected: null-plan
{
  "plan": null,
  "replay": false
}

Validate

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