VipCheckout vip.checkout@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/checkout.v1.json

vip.checkout@1: a checkout hand-off on OpenVibe.VIP (server/domain/checkout.js present): the plan version a member chose, recorded before VIP hands the purchase to OpenVibe.Billing (a subscription paid from credit, or a Billing payment intent). status created → handed_off (sent to the provider) or paid (credit) → used (the membership was filed under it); failed when Billing refused.

Fields

FieldTypeRequiredDescriptionConstraints
idstringyes
  • pattern ^vco_[0-9A-HJKMNP-TV-Z]{26}$
memberidentity.subject-refyes
creator_idstringyes
  • pattern ^vcr_[0-9A-HJKMNP-TV-Z]{26}$
plan_idstringyes
  • pattern ^vpl_[0-9A-HJKMNP-TV-Z]{26}$
plan_version_idstring | nullyes
providerstringyesA checkout provider VIP offers (VIP_CHECKOUT_PROVIDERS; powerchat and credit by default).
statusenumyes
  • one of "created", "handed_off", "paid", "failed", "used"
billing_intent_idstring | nullyes
billing_subscription_idstring | nullyes
checkout_urlstring | nullyes
checkout_refstring | nullyes
created_atstringyes
  • format date-time

Examples

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

Valid: handed-off
{
  "id": "vco_01JAB2C3D4E5F6G7H8J9K0MNQ0",
  "member": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
  },
  "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "plan_id": "vpl_01JAB2C3D4E5F6G7H8J9K0MNPW",
  "plan_version_id": "vpv_01JAB2C3D4E5F6G7H8J9K0MNPT",
  "provider": "powerchat",
  "status": "handed_off",
  "billing_intent_id": "int_01JAB2C3D4E5F6G7H8J9K0MNQ1",
  "billing_subscription_id": null,
  "checkout_url": "https://powerchat.live/checkout/pc_7f3a91",
  "checkout_ref": "pc_7f3a91",
  "created_at": "2026-09-25T09:12:40.118Z"
}
Rejected: bad-status
{
  "id": "vco_01JAB2C3D4E5F6G7H8J9K0MNQ0",
  "member": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPR"
  },
  "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
  "plan_id": "vpl_01JAB2C3D4E5F6G7H8J9K0MNPW",
  "plan_version_id": "vpv_01JAB2C3D4E5F6G7H8J9K0MNPT",
  "provider": "powerchat",
  "status": "pending",
  "billing_intent_id": "int_01JAB2C3D4E5F6G7H8J9K0MNQ1",
  "billing_subscription_id": null,
  "checkout_url": "https://powerchat.live/checkout/pc_7f3a91",
  "checkout_ref": "pc_7f3a91",
  "created_at": "2026-09-25T09:12:40.118Z"
}

Validate

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