VipPerkListResult vip.perk-list-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/perk-list-result.v1.json

vip.perk-list-result@1: the answer of vip.perk.list on OpenVibe.VIP. GET /api/v1/perks?creator=&network=&retired= → { perks }: a creator's active perks plus the network's (network=0 leaves those out), ordered creator first then by name; retired=1 adds retired perks for the creator, staff or a service holding vip.perk.list. 404 vip.creator_not_found (problem+json) when creator names nobody.

Fields

FieldTypeRequiredDescriptionConstraints
perksvip.perkyes

Examples

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

Valid: perks
{
  "perks": [
    {
      "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNPV",
      "key": "chat-badge",
      "name": "Chat badge",
      "description": "A supporter badge next to your name in chat.",
      "kind": "badge",
      "status": "active",
      "scope": "creator",
      "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "bindings": [
        {
          "product": "chat",
          "binding": "chat_badge",
          "config": {
            "icon": "star"
          }
        },
        {
          "product": "live",
          "binding": "chat_badge",
          "config": {}
        }
      ],
      "updated_at": "2026-09-20T18:04:11.402Z"
    },
    {
      "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNQ2",
      "key": "founder",
      "name": "Founder",
      "description": null,
      "kind": "role",
      "status": "active",
      "scope": "network",
      "creator_id": "network",
      "bindings": [],
      "updated_at": "2026-09-20T18:04:11.402Z"
    }
  ]
}
Rejected: bad-scope
{
  "perks": [
    {
      "id": "vpk_01JAB2C3D4E5F6G7H8J9K0MNPV",
      "key": "chat-badge",
      "name": "Chat badge",
      "description": "A supporter badge next to your name in chat.",
      "kind": "badge",
      "status": "active",
      "scope": "global",
      "creator_id": "vcr_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "bindings": [
        {
          "product": "chat",
          "binding": "chat_badge",
          "config": {
            "icon": "star"
          }
        },
        {
          "product": "live",
          "binding": "chat_badge",
          "config": {}
        }
      ],
      "updated_at": "2026-09-20T18:04:11.402Z"
    }
  ]
}

Validate

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