SosoAPI
Start for free
EN
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
Start for free

Search loads only when you use it. Browse all categories below.

Accounts and workspaces

Get Organization billing facts

Read actual Organization plan, invoice-derived pricing and pending changes under the selected Workspace and current Organization Owner authority. This cannot claim an offer or change billing.

POST /identity-api/commercial-access/billing/status

Contract reviewed: · sha256:794dfa010f25b5de

Read as MarkdownDownload public contractDownload OpenAPI

Overview

Read actual Organization plan, invoice-derived pricing and pending changes under the selected Workspace and current Organization Owner authority. This cannot claim an offer or change billing.

A successful HTTP response can mean that a request was accepted rather than completed. For background work, save the returned ID and check the same operation until it finishes. A scheduled or accepted post is published only when the platform confirms it; a client timeout does not establish the result.

Authentication and permissions

Accepted credential classes
user_session, delegated_oauth, personal_access_token
Delegated capability
agent:operate
Minimum workspace role
No workspace-role minimum in this contract; ownership and grant checks still apply.
Access scope
Resources this user is authorized to access
All-workspace consent required
No
Changes state
No
When the operation is complete
synchronous_http_response

A token can use only the rights held by its owner. Each request checks workspace membership, resource ownership, selected workspaces and granted capabilities. Core and full profiles change which tools are displayed; they do not grant access.

Request fields

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Request fields
Field / branchType / requiredConstraints
$objectRequired in parent
  • additionalProperties: false
workspace_idstringRequired in parent
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Complete JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Response and completion

Success HTTP statuses: 200. When the operation is complete: synchronous_http_response.

A successful HTTP response can mean that a request was accepted rather than completed. For background work, save the returned ID and check the same operation until it finishes. A scheduled or accepted post is published only when the platform confirms it; a client timeout does not establish the result.

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Response and completion
Field / branchType / requiredConstraints
$objectRequired in parent—
contract_versionstringRequired in parent
  • const: "organization-commercial-billing/v1"
workspace_idstringRequired in parent
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
organization_idstringRequired in parent
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
planstringRequired in parent
  • enum: ["free","founding_pro","pro","team"]
plan_limitsobjectRequired in parent—
plan_limitsoneOf 1objectRequired in parent—
plan_limits.planoneOf 1stringRequired in parent
  • const: "free"
plan_limits.included_human_seatsoneOf 1number | nullRequired in parent—
plan_limits.included_human_seatsoneOf 1 / anyOf 1numberRequired in parent
  • const: 1
plan_limits.included_human_seatsoneOf 1 / anyOf 2nullRequired in parent—
plan_limits.connected_channel_limitoneOf 1numberRequired in parent
  • const: 3
plan_limits.successful_destination_publishes_limitoneOf 1number | nullRequired in parent—
plan_limits.successful_destination_publishes_limitoneOf 1 / anyOf 1numberRequired in parent
  • const: 100
plan_limits.successful_destination_publishes_limitoneOf 1 / anyOf 2nullRequired in parent—
plan_limits.pending_scheduled_posts_limitoneOf 1numberRequired in parent
  • const: 30
plan_limits.history_daysoneOf 1numberRequired in parent
  • const: 30
plan_limits.stripe_quantityoneOf 1numberRequired in parent
  • const: 0
plan_limitsoneOf 2objectRequired in parent—
plan_limits.planoneOf 2stringRequired in parent
  • const: "founding_pro"
plan_limits.included_human_seatsoneOf 2number | nullRequired in parent—
plan_limits.included_human_seatsoneOf 2 / anyOf 1numberRequired in parent
  • const: 5
plan_limits.included_human_seatsoneOf 2 / anyOf 2nullRequired in parent—
plan_limits.connected_channel_limitoneOf 2numberRequired in parent—
plan_limits.connected_channel_limitoneOf 2 / anyOf 1numberRequired in parent
  • const: 10
plan_limits.connected_channel_limitoneOf 2 / anyOf 2numberRequired in parent
  • const: 20
plan_limits.successful_destination_publishes_limitoneOf 2number | nullRequired in parent—
plan_limits.successful_destination_publishes_limitoneOf 2 / anyOf 1numberRequired in parent
  • const: 1000
plan_limits.successful_destination_publishes_limitoneOf 2 / anyOf 2nullRequired in parent—
plan_limits.pending_scheduled_posts_limitoneOf 2numberRequired in parent
  • const: 300
plan_limits.history_daysoneOf 2numberRequired in parent
  • const: 365
plan_limits.stripe_quantityoneOf 2numberRequired in parent
  • const: 1
plan_limitsoneOf 3objectRequired in parent—
plan_limits.planoneOf 3stringRequired in parent
  • const: "pro"
plan_limits.included_human_seatsoneOf 3nullRequired in parent—
plan_limits.connected_channel_limitoneOf 3numberRequired in parent
  • const: 10
plan_limits.successful_destination_publishes_limitoneOf 3nullRequired in parent—
plan_limits.unlimited_publishing_platformsoneOf 3arrayRequired in parent
  • minItems: 4
  • maxItems: 4
plan_limits.pending_scheduled_posts_limitoneOf 3numberRequired in parent
  • const: 300
plan_limits.history_daysoneOf 3numberRequired in parent
  • const: 365
plan_limits.stripe_quantityoneOf 3numberRequired in parent
  • const: 1
plan_limitsoneOf 4objectRequired in parent—
plan_limits.planoneOf 4stringRequired in parent
  • const: "team"
plan_limits.included_human_seatsoneOf 4nullRequired in parent—
plan_limits.connected_channel_limitoneOf 4numberRequired in parent
  • const: 20
plan_limits.successful_destination_publishes_limitoneOf 4nullRequired in parent—
plan_limits.unlimited_publishing_platformsoneOf 4arrayRequired in parent
  • minItems: 4
  • maxItems: 4
plan_limits.pending_scheduled_posts_limitoneOf 4numberRequired in parent
  • const: 300
plan_limits.history_daysoneOf 4numberRequired in parent
  • const: 365
plan_limits.stripe_quantityoneOf 4numberRequired in parent
  • const: 1
pricingobjectRequired in parent—
pricingoneOf 1objectRequired in parent—
pricingoneOf 1 / oneOf 1objectRequired in parent—
pricing.statusoneOf 1 / oneOf 1stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 1 / oneOf 1stringRequired in parent
  • const: "standard"
pricing.authorityoneOf 1 / oneOf 1stringRequired in parent
  • const: "default_free"
pricing.planoneOf 1 / oneOf 1stringRequired in parent
  • const: "free"
pricing.plan_versiononeOf 1 / oneOf 1numberRequired in parent—
pricing.plan_versiononeOf 1 / oneOf 1 / anyOf 1numberRequired in parent
  • const: 1
pricing.plan_versiononeOf 1 / oneOf 1 / anyOf 2numberRequired in parent
  • const: 2
pricing.currencyoneOf 1 / oneOf 1stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 1 / oneOf 1stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 1 / oneOf 1numberRequired in parent
  • const: 0
pricingoneOf 1 / oneOf 2objectRequired in parent—
pricing.statusoneOf 1 / oneOf 2stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 1 / oneOf 2stringRequired in parent
  • const: "standard"
pricing.authorityoneOf 1 / oneOf 2stringRequired in parent
  • const: "verified_invoice"
pricing.planoneOf 1 / oneOf 2stringRequired in parent
  • const: "pro"
pricing.plan_versiononeOf 1 / oneOf 2numberRequired in parent
  • const: 1
pricing.currencyoneOf 1 / oneOf 2stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 1 / oneOf 2stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 1 / oneOf 2numberRequired in parent
  • const: 4000
pricing.verified_periodoneOf 1 / oneOf 2objectRequired in parent—
pricing.verified_period.period_startoneOf 1 / oneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricing.verified_period.period_endoneOf 1 / oneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricingoneOf 1 / oneOf 3objectRequired in parent—
pricing.statusoneOf 1 / oneOf 3stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 1 / oneOf 3stringRequired in parent
  • const: "standard"
pricing.authorityoneOf 1 / oneOf 3stringRequired in parent
  • const: "verified_invoice"
pricing.planoneOf 1 / oneOf 3stringRequired in parent
  • const: "team"
pricing.plan_versiononeOf 1 / oneOf 3numberRequired in parent
  • const: 1
pricing.currencyoneOf 1 / oneOf 3stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 1 / oneOf 3stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 1 / oneOf 3numberRequired in parent
  • const: 8000
pricing.verified_periodoneOf 1 / oneOf 3objectRequired in parent—
pricing.verified_period.period_startoneOf 1 / oneOf 3stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricing.verified_period.period_endoneOf 1 / oneOf 3stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricingoneOf 2objectRequired in parent—
pricingoneOf 2 / oneOf 1objectRequired in parent—
pricing.statusoneOf 2 / oneOf 1stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 2 / oneOf 1stringRequired in parent
  • const: "promotional"
pricing.authorityoneOf 2 / oneOf 1stringRequired in parent
  • const: "verified_invoice"
pricing.planoneOf 2 / oneOf 1stringRequired in parent
  • const: "pro"
pricing.plan_versiononeOf 2 / oneOf 1numberRequired in parent
  • const: 2
pricing.currencyoneOf 2 / oneOf 1stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 2 / oneOf 1stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 2 / oneOf 1numberRequired in parent
  • const: 1900
pricing.verified_periodoneOf 2 / oneOf 1objectRequired in parent—
pricing.verified_period.period_startoneOf 2 / oneOf 1stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricing.verified_period.period_endoneOf 2 / oneOf 1stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricingoneOf 2 / oneOf 2objectRequired in parent—
pricing.statusoneOf 2 / oneOf 2stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 2 / oneOf 2stringRequired in parent
  • const: "promotional"
pricing.authorityoneOf 2 / oneOf 2stringRequired in parent
  • const: "verified_invoice"
pricing.planoneOf 2 / oneOf 2stringRequired in parent
  • const: "team"
pricing.plan_versiononeOf 2 / oneOf 2numberRequired in parent
  • const: 2
pricing.currencyoneOf 2 / oneOf 2stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 2 / oneOf 2stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 2 / oneOf 2numberRequired in parent
  • const: 3900
pricing.verified_periodoneOf 2 / oneOf 2objectRequired in parent—
pricing.verified_period.period_startoneOf 2 / oneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricing.verified_period.period_endoneOf 2 / oneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricingoneOf 3objectRequired in parent—
pricingoneOf 3 / oneOf 1objectRequired in parent—
pricing.statusoneOf 3 / oneOf 1stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 3 / oneOf 1stringRequired in parent
  • const: "legacy"
pricing.planoneOf 3 / oneOf 1stringRequired in parent
  • const: "founding_pro"
pricing.plan_versiononeOf 3 / oneOf 1integerRequired in parent
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.currencyoneOf 3 / oneOf 1stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 3 / oneOf 1stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 3 / oneOf 1integerRequired in parent
  • minimum: 0
  • maximum: 2147483647
pricing.authorityoneOf 3 / oneOf 1stringRequired in parent
  • const: "legacy_commitment"
pricingoneOf 3 / oneOf 2objectRequired in parent—
pricing.statusoneOf 3 / oneOf 2stringRequired in parent
  • const: "available"
pricing.source_kindoneOf 3 / oneOf 2stringRequired in parent
  • const: "legacy"
pricing.planoneOf 3 / oneOf 2stringRequired in parent
  • const: "founding_pro"
pricing.plan_versiononeOf 3 / oneOf 2integerRequired in parent
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.currencyoneOf 3 / oneOf 2stringRequired in parent
  • const: "usd"
pricing.interval_unitoneOf 3 / oneOf 2stringRequired in parent
  • const: "month"
pricing.monthly_amount_centsoneOf 3 / oneOf 2integerRequired in parent
  • minimum: 0
  • maximum: 2147483647
pricing.authorityoneOf 3 / oneOf 2stringRequired in parent
  • const: "verified_invoice"
pricing.verified_periodoneOf 3 / oneOf 2objectRequired in parent—
pricing.verified_period.period_startoneOf 3 / oneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricing.verified_period.period_endoneOf 3 / oneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pricingoneOf 4objectRequired in parent—
pricing.statusoneOf 4stringRequired in parent
  • const: "unavailable"
pricing.source_kindoneOf 4stringRequired in parent
  • const: "manual"
pricing.authorityoneOf 4stringRequired in parent
  • const: "manual_grant"
pricing.planoneOf 4stringRequired in parent
  • enum: ["free","founding_pro","pro","team"]
pricing.plan_versiononeOf 4integerRequired in parent
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.monthly_amount_centsoneOf 4nullRequired in parent—
pricing.reason_codeoneOf 4stringRequired in parent
  • const: "recurring_charge_not_observed"
pricingoneOf 5objectRequired in parent—
pricing.statusoneOf 5stringRequired in parent
  • const: "unavailable"
pricing.source_kindoneOf 5stringRequired in parent
  • const: "unavailable"
pricing.authorityoneOf 5stringRequired in parent
  • const: "not_observed"
pricing.planoneOf 5stringRequired in parent
  • enum: ["free","founding_pro","pro","team"]
pricing.plan_versiononeOf 5integer | nullRequired in parent—
pricing.plan_versiononeOf 5 / anyOf 1integerRequired in parent
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.plan_versiononeOf 5 / anyOf 2nullRequired in parent—
pricing.monthly_amount_centsoneOf 5nullRequired in parent—
pricing.reason_codeoneOf 5stringRequired in parent
  • enum: ["current_period_proof_missing","pricing_authority_not_observed","catalog_binding_not_observed"]
purchase_optionsobjectRequired in parent—
purchase_optionsoneOf 1objectRequired in parent—
purchase_options.statusoneOf 1stringRequired in parent
  • const: "unavailable"
purchase_options.reason_codeoneOf 1stringRequired in parent
  • enum: ["checkout_disabled","catalog_unconfigured"]
purchase_optionsoneOf 2objectRequired in parent—
purchase_options.statusoneOf 2stringRequired in parent
  • const: "configured"
purchase_options.catalog_versiononeOf 2stringRequired in parent
  • const: "organization-monthly-2026-10-24"
purchase_options.plansoneOf 2objectRequired in parent—
purchase_options.plans.prooneOf 2objectRequired in parent—
purchase_options.plans.pro.planoneOf 2stringRequired in parent
  • const: "pro"
purchase_options.plans.pro.plan_versiononeOf 2numberRequired in parent
  • const: 1
purchase_options.plans.pro.currencyoneOf 2stringRequired in parent
  • const: "usd"
purchase_options.plans.pro.interval_unitoneOf 2stringRequired in parent
  • const: "month"
purchase_options.plans.pro.monthly_amount_centsoneOf 2numberRequired in parent
  • const: 4000
purchase_options.plans.teamoneOf 2objectRequired in parent—
purchase_options.plans.team.planoneOf 2stringRequired in parent
  • const: "team"
purchase_options.plans.team.plan_versiononeOf 2numberRequired in parent
  • const: 1
purchase_options.plans.team.currencyoneOf 2stringRequired in parent
  • const: "usd"
purchase_options.plans.team.interval_unitoneOf 2stringRequired in parent
  • const: "month"
purchase_options.plans.team.monthly_amount_centsoneOf 2numberRequired in parent
  • const: 8000
pending_changeobjectRequired in parent—
pending_changeoneOf 1objectRequired in parent—
pending_change.statusoneOf 1stringRequired in parent
  • const: "not_observed"
pending_changeoneOf 2objectRequired in parent—
pending_change.statusoneOf 2stringRequired in parent
  • enum: ["scheduled","blocked_by_cancellation","terminated"]
pending_change.target_planoneOf 2stringRequired in parent
  • enum: ["pro","team"]
pending_change.target_plan_versiononeOf 2numberRequired in parent—
pending_change.target_plan_versiononeOf 2 / anyOf 1numberRequired in parent
  • const: 1
pending_change.target_plan_versiononeOf 2 / anyOf 2numberRequired in parent
  • const: 2
pending_change.source_kindoneOf 2stringRequired in parent
  • enum: ["standard","promotional"]
pending_change.currencyoneOf 2stringRequired in parent
  • const: "usd"
pending_change.interval_unitoneOf 2stringRequired in parent
  • const: "month"
pending_change.monthly_amount_centsoneOf 2numberRequired in parent—
pending_change.monthly_amount_centsoneOf 2 / anyOf 1numberRequired in parent
  • const: 4000
pending_change.monthly_amount_centsoneOf 2 / anyOf 2numberRequired in parent
  • const: 8000
pending_change.monthly_amount_centsoneOf 2 / anyOf 3numberRequired in parent
  • const: 1900
pending_change.monthly_amount_centsoneOf 2 / anyOf 4numberRequired in parent
  • const: 3900
pending_change.effective_atoneOf 2stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
pending_change.activationoneOf 2stringRequired in parent
  • const: "next_paid_invoice"
pending_changeoneOf 3objectRequired in parent—
pending_change.statusoneOf 3stringRequired in parent
  • const: "unavailable"
pending_change.reason_codeoneOf 3stringRequired in parent
  • const: "pending_change_authority_not_observed"
continuous_lockobjectRequired in parent—
continuous_lockoneOf 1objectRequired in parent—
continuous_lock.statusoneOf 1stringRequired in parent
  • const: "not_observed"
continuous_lockoneOf 2objectRequired in parent—
continuous_lock.statusoneOf 2stringRequired in parent
  • const: "none"
continuous_lock.reason_codeoneOf 2stringRequired in parent
  • const: "standard_subscription"
continuous_lockoneOf 3objectRequired in parent—
continuous_lock.statusoneOf 3stringRequired in parent
  • const: "active"
continuous_lock.source_kindoneOf 3stringRequired in parent
  • const: "promotional"
continuous_lock.currencyoneOf 3stringRequired in parent
  • const: "usd"
continuous_lock.interval_unitoneOf 3stringRequired in parent
  • const: "month"
continuous_lock.pro_monthly_amount_centsoneOf 3numberRequired in parent
  • const: 1900
continuous_lock.team_monthly_amount_centsoneOf 3numberRequired in parent
  • const: 3900
continuous_lockoneOf 4objectRequired in parent—
continuous_lock.statusoneOf 4stringRequired in parent
  • const: "terminated"
continuous_lock.ended_atoneOf 4stringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
continuous_lockoneOf 5objectRequired in parent—
continuous_lock.statusoneOf 5stringRequired in parent
  • const: "unavailable"
continuous_lock.reason_codeoneOf 5stringRequired in parent
  • const: "commitment_authority_not_observed"
observed_atstringRequired in parent
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
Complete JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "organization-commercial-billing/v1"
    },
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "organization_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "plan": {
      "type": "string",
      "enum": [
        "free",
        "founding_pro",
        "pro",
        "team"
      ]
    },
    "plan_limits": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "plan": {
              "type": "string",
              "const": "free"
            },
            "included_human_seats": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 1
                },
                {
                  "type": "null"
                }
              ]
            },
            "connected_channel_limit": {
              "type": "number",
              "const": 3
            },
            "successful_destination_publishes_limit": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 100
                },
                {
                  "type": "null"
                }
              ]
            },
            "pending_scheduled_posts_limit": {
              "type": "number",
              "const": 30
            },
            "history_days": {
              "type": "number",
              "const": 30
            },
            "stripe_quantity": {
              "type": "number",
              "const": 0
            }
          },
          "required": [
            "plan",
            "included_human_seats",
            "connected_channel_limit",
            "successful_destination_publishes_limit",
            "pending_scheduled_posts_limit",
            "history_days",
            "stripe_quantity"
          ]
        },
        {
          "type": "object",
          "properties": {
            "plan": {
              "type": "string",
              "const": "founding_pro"
            },
            "included_human_seats": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 5
                },
                {
                  "type": "null"
                }
              ]
            },
            "connected_channel_limit": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 10
                },
                {
                  "type": "number",
                  "const": 20
                }
              ]
            },
            "successful_destination_publishes_limit": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 1000
                },
                {
                  "type": "null"
                }
              ]
            },
            "pending_scheduled_posts_limit": {
              "type": "number",
              "const": 300
            },
            "history_days": {
              "type": "number",
              "const": 365
            },
            "stripe_quantity": {
              "type": "number",
              "const": 1
            }
          },
          "required": [
            "plan",
            "included_human_seats",
            "connected_channel_limit",
            "successful_destination_publishes_limit",
            "pending_scheduled_posts_limit",
            "history_days",
            "stripe_quantity"
          ]
        },
        {
          "type": "object",
          "properties": {
            "plan": {
              "type": "string",
              "const": "pro"
            },
            "included_human_seats": {
              "type": "null"
            },
            "connected_channel_limit": {
              "type": "number",
              "const": 10
            },
            "successful_destination_publishes_limit": {
              "type": "null"
            },
            "unlimited_publishing_platforms": {
              "type": "array",
              "prefixItems": [
                {
                  "type": "string",
                  "const": "instagram"
                },
                {
                  "type": "string",
                  "const": "facebook"
                },
                {
                  "type": "string",
                  "const": "threads"
                },
                {
                  "type": "string",
                  "const": "youtube"
                }
              ],
              "items": false,
              "minItems": 4,
              "maxItems": 4
            },
            "pending_scheduled_posts_limit": {
              "type": "number",
              "const": 300
            },
            "history_days": {
              "type": "number",
              "const": 365
            },
            "stripe_quantity": {
              "type": "number",
              "const": 1
            }
          },
          "required": [
            "plan",
            "included_human_seats",
            "connected_channel_limit",
            "successful_destination_publishes_limit",
            "unlimited_publishing_platforms",
            "pending_scheduled_posts_limit",
            "history_days",
            "stripe_quantity"
          ]
        },
        {
          "type": "object",
          "properties": {
            "plan": {
              "type": "string",
              "const": "team"
            },
            "included_human_seats": {
              "type": "null"
            },
            "connected_channel_limit": {
              "type": "number",
              "const": 20
            },
            "successful_destination_publishes_limit": {
              "type": "null"
            },
            "unlimited_publishing_platforms": {
              "type": "array",
              "prefixItems": [
                {
                  "type": "string",
                  "const": "instagram"
                },
                {
                  "type": "string",
                  "const": "facebook"
                },
                {
                  "type": "string",
                  "const": "threads"
                },
                {
                  "type": "string",
                  "const": "youtube"
                }
              ],
              "items": false,
              "minItems": 4,
              "maxItems": 4
            },
            "pending_scheduled_posts_limit": {
              "type": "number",
              "const": 300
            },
            "history_days": {
              "type": "number",
              "const": 365
            },
            "stripe_quantity": {
              "type": "number",
              "const": 1
            }
          },
          "required": [
            "plan",
            "included_human_seats",
            "connected_channel_limit",
            "successful_destination_publishes_limit",
            "unlimited_publishing_platforms",
            "pending_scheduled_posts_limit",
            "history_days",
            "stripe_quantity"
          ]
        }
      ]
    },
    "pricing": {
      "oneOf": [
        {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "standard"
                },
                "authority": {
                  "type": "string",
                  "const": "default_free"
                },
                "plan": {
                  "type": "string",
                  "const": "free"
                },
                "plan_version": {
                  "anyOf": [
                    {
                      "type": "number",
                      "const": 1
                    },
                    {
                      "type": "number",
                      "const": 2
                    }
                  ]
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "number",
                  "const": 0
                }
              },
              "required": [
                "status",
                "source_kind",
                "authority",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents"
              ]
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "standard"
                },
                "authority": {
                  "type": "string",
                  "const": "verified_invoice"
                },
                "plan": {
                  "type": "string",
                  "const": "pro"
                },
                "plan_version": {
                  "type": "number",
                  "const": 1
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "number",
                  "const": 4000
                },
                "verified_period": {
                  "type": "object",
                  "properties": {
                    "period_start": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "period_end": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "period_start",
                    "period_end"
                  ]
                }
              },
              "required": [
                "status",
                "source_kind",
                "authority",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents",
                "verified_period"
              ]
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "standard"
                },
                "authority": {
                  "type": "string",
                  "const": "verified_invoice"
                },
                "plan": {
                  "type": "string",
                  "const": "team"
                },
                "plan_version": {
                  "type": "number",
                  "const": 1
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "number",
                  "const": 8000
                },
                "verified_period": {
                  "type": "object",
                  "properties": {
                    "period_start": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "period_end": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "period_start",
                    "period_end"
                  ]
                }
              },
              "required": [
                "status",
                "source_kind",
                "authority",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents",
                "verified_period"
              ]
            }
          ]
        },
        {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "promotional"
                },
                "authority": {
                  "type": "string",
                  "const": "verified_invoice"
                },
                "plan": {
                  "type": "string",
                  "const": "pro"
                },
                "plan_version": {
                  "type": "number",
                  "const": 2
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "number",
                  "const": 1900
                },
                "verified_period": {
                  "type": "object",
                  "properties": {
                    "period_start": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "period_end": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "period_start",
                    "period_end"
                  ]
                }
              },
              "required": [
                "status",
                "source_kind",
                "authority",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents",
                "verified_period"
              ]
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "promotional"
                },
                "authority": {
                  "type": "string",
                  "const": "verified_invoice"
                },
                "plan": {
                  "type": "string",
                  "const": "team"
                },
                "plan_version": {
                  "type": "number",
                  "const": 2
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "number",
                  "const": 3900
                },
                "verified_period": {
                  "type": "object",
                  "properties": {
                    "period_start": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "period_end": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "period_start",
                    "period_end"
                  ]
                }
              },
              "required": [
                "status",
                "source_kind",
                "authority",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents",
                "verified_period"
              ]
            }
          ]
        },
        {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "legacy"
                },
                "plan": {
                  "type": "string",
                  "const": "founding_pro"
                },
                "plan_version": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 2147483647
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                "authority": {
                  "type": "string",
                  "const": "legacy_commitment"
                }
              },
              "required": [
                "status",
                "source_kind",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents",
                "authority"
              ]
            },
            {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "const": "available"
                },
                "source_kind": {
                  "type": "string",
                  "const": "legacy"
                },
                "plan": {
                  "type": "string",
                  "const": "founding_pro"
                },
                "plan_version": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 2147483647
                },
                "currency": {
                  "type": "string",
                  "const": "usd"
                },
                "interval_unit": {
                  "type": "string",
                  "const": "month"
                },
                "monthly_amount_cents": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                "authority": {
                  "type": "string",
                  "const": "verified_invoice"
                },
                "verified_period": {
                  "type": "object",
                  "properties": {
                    "period_start": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "period_end": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "period_start",
                    "period_end"
                  ]
                }
              },
              "required": [
                "status",
                "source_kind",
                "plan",
                "plan_version",
                "currency",
                "interval_unit",
                "monthly_amount_cents",
                "authority",
                "verified_period"
              ]
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "unavailable"
            },
            "source_kind": {
              "type": "string",
              "const": "manual"
            },
            "authority": {
              "type": "string",
              "const": "manual_grant"
            },
            "plan": {
              "type": "string",
              "enum": [
                "free",
                "founding_pro",
                "pro",
                "team"
              ]
            },
            "plan_version": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 2147483647
            },
            "monthly_amount_cents": {
              "type": "null"
            },
            "reason_code": {
              "type": "string",
              "const": "recurring_charge_not_observed"
            }
          },
          "required": [
            "status",
            "source_kind",
            "authority",
            "plan",
            "plan_version",
            "monthly_amount_cents",
            "reason_code"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "unavailable"
            },
            "source_kind": {
              "type": "string",
              "const": "unavailable"
            },
            "authority": {
              "type": "string",
              "const": "not_observed"
            },
            "plan": {
              "type": "string",
              "enum": [
                "free",
                "founding_pro",
                "pro",
                "team"
              ]
            },
            "plan_version": {
              "anyOf": [
                {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 2147483647
                },
                {
                  "type": "null"
                }
              ]
            },
            "monthly_amount_cents": {
              "type": "null"
            },
            "reason_code": {
              "type": "string",
              "enum": [
                "current_period_proof_missing",
                "pricing_authority_not_observed",
                "catalog_binding_not_observed"
              ]
            }
          },
          "required": [
            "status",
            "source_kind",
            "authority",
            "plan",
            "plan_version",
            "monthly_amount_cents",
            "reason_code"
          ]
        }
      ]
    },
    "purchase_options": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "unavailable"
            },
            "reason_code": {
              "type": "string",
              "enum": [
                "checkout_disabled",
                "catalog_unconfigured"
              ]
            }
          },
          "required": [
            "status",
            "reason_code"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "configured"
            },
            "catalog_version": {
              "type": "string",
              "const": "organization-monthly-2026-10-24"
            },
            "plans": {
              "type": "object",
              "properties": {
                "pro": {
                  "type": "object",
                  "properties": {
                    "plan": {
                      "type": "string",
                      "const": "pro"
                    },
                    "plan_version": {
                      "type": "number",
                      "const": 1
                    },
                    "currency": {
                      "type": "string",
                      "const": "usd"
                    },
                    "interval_unit": {
                      "type": "string",
                      "const": "month"
                    },
                    "monthly_amount_cents": {
                      "type": "number",
                      "const": 4000
                    }
                  },
                  "required": [
                    "plan",
                    "plan_version",
                    "currency",
                    "interval_unit",
                    "monthly_amount_cents"
                  ]
                },
                "team": {
                  "type": "object",
                  "properties": {
                    "plan": {
                      "type": "string",
                      "const": "team"
                    },
                    "plan_version": {
                      "type": "number",
                      "const": 1
                    },
                    "currency": {
                      "type": "string",
                      "const": "usd"
                    },
                    "interval_unit": {
                      "type": "string",
                      "const": "month"
                    },
                    "monthly_amount_cents": {
                      "type": "number",
                      "const": 8000
                    }
                  },
                  "required": [
                    "plan",
                    "plan_version",
                    "currency",
                    "interval_unit",
                    "monthly_amount_cents"
                  ]
                }
              },
              "required": [
                "pro",
                "team"
              ]
            }
          },
          "required": [
            "status",
            "catalog_version",
            "plans"
          ]
        }
      ]
    },
    "pending_change": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "not_observed"
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "scheduled",
                "blocked_by_cancellation",
                "terminated"
              ]
            },
            "target_plan": {
              "type": "string",
              "enum": [
                "pro",
                "team"
              ]
            },
            "target_plan_version": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 1
                },
                {
                  "type": "number",
                  "const": 2
                }
              ]
            },
            "source_kind": {
              "type": "string",
              "enum": [
                "standard",
                "promotional"
              ]
            },
            "currency": {
              "type": "string",
              "const": "usd"
            },
            "interval_unit": {
              "type": "string",
              "const": "month"
            },
            "monthly_amount_cents": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 4000
                },
                {
                  "type": "number",
                  "const": 8000
                },
                {
                  "type": "number",
                  "const": 1900
                },
                {
                  "type": "number",
                  "const": 3900
                }
              ]
            },
            "effective_at": {
              "type": "string",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
              "format": "date-time"
            },
            "activation": {
              "type": "string",
              "const": "next_paid_invoice"
            }
          },
          "required": [
            "status",
            "target_plan",
            "target_plan_version",
            "source_kind",
            "currency",
            "interval_unit",
            "monthly_amount_cents",
            "effective_at",
            "activation"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "unavailable"
            },
            "reason_code": {
              "type": "string",
              "const": "pending_change_authority_not_observed"
            }
          },
          "required": [
            "status",
            "reason_code"
          ]
        }
      ]
    },
    "continuous_lock": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "not_observed"
            }
          },
          "required": [
            "status"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "none"
            },
            "reason_code": {
              "type": "string",
              "const": "standard_subscription"
            }
          },
          "required": [
            "status",
            "reason_code"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "active"
            },
            "source_kind": {
              "type": "string",
              "const": "promotional"
            },
            "currency": {
              "type": "string",
              "const": "usd"
            },
            "interval_unit": {
              "type": "string",
              "const": "month"
            },
            "pro_monthly_amount_cents": {
              "type": "number",
              "const": 1900
            },
            "team_monthly_amount_cents": {
              "type": "number",
              "const": 3900
            }
          },
          "required": [
            "status",
            "source_kind",
            "currency",
            "interval_unit",
            "pro_monthly_amount_cents",
            "team_monthly_amount_cents"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "terminated"
            },
            "ended_at": {
              "type": "string",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
              "format": "date-time"
            }
          },
          "required": [
            "status",
            "ended_at"
          ]
        },
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "const": "unavailable"
            },
            "reason_code": {
              "type": "string",
              "const": "commitment_authority_not_observed"
            }
          },
          "required": [
            "status",
            "reason_code"
          ]
        }
      ]
    },
    "observed_at": {
      "type": "string",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "format": "date-time"
    }
  },
  "required": [
    "contract_version",
    "workspace_id",
    "organization_id",
    "plan",
    "plan_limits",
    "pricing",
    "purchase_options",
    "pending_change",
    "continuous_lock",
    "observed_at"
  ]
}

Errors and safe retries

Check the HTTP status and response body. A 400 validation error may contain a ZodError; handler errors use error, message and code fields. Keep request_id or x-request-id for diagnosis, without credentials. Fix 401/403 access errors before retrying, and follow Retry-After for 429. If a write is uncertain or returns 5xx, read the existing result first. Reuse an idempotency key only where supported; retry behaviour varies by operation and does not guarantee exactly-once delivery.

Troubleshooting guide

Examples

These examples use fictional values checked against the schemas. Replace the IDs with ones you are authorized to use, the media with ready assets and the dates with your confirmed publishing time. Check the account’s eligibility before submitting a write. This page sends no API requests.

Set SOSOAPI_ACCESS_TOKEN on your server to a credential accepted by this operation, and keep it out of browser code. For an agent, use sosoapi auth login to sign in through the browser and let the CLI refresh its credentials.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/commercial-access/billing/status" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/commercial-access/billing/status", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/commercial-access/billing/status < request.json

Synthetic response example

{
  "contract_version": "organization-commercial-billing/v1",
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "organization_id": "11111111-1111-4111-8111-111111111111",
  "plan": "free",
  "plan_limits": {
    "plan": "free",
    "included_human_seats": null,
    "connected_channel_limit": 3,
    "successful_destination_publishes_limit": null,
    "pending_scheduled_posts_limit": 30,
    "history_days": 30,
    "stripe_quantity": 0
  },
  "pricing": {
    "status": "available",
    "source_kind": "standard",
    "authority": "default_free",
    "plan": "free",
    "plan_version": 1,
    "currency": "usd",
    "interval_unit": "month",
    "monthly_amount_cents": 0
  },
  "purchase_options": {
    "status": "unavailable",
    "reason_code": "checkout_disabled"
  },
  "pending_change": {
    "status": "not_observed"
  },
  "continuous_lock": {
    "status": "not_observed"
  },
  "observed_at": "2099-01-15T09:00:00Z"
}

MCP: sosoapi_get_organization_billing

All API operationsAuthentication and permissions