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

A busca carrega apenas quando você a usa. Explore todas as categorias abaixo.

Contas e workspaces

Obter dados de cobrança da organização

Consulte o plano real da organização, os preços derivados das faturas e as alterações pendentes no contexto do Workspace selecionado e com a autoridade atual do proprietário da organização. Esta consulta não permite resgatar uma oferta nem alterar a cobrança.

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

Contrato revisado: · sha256:794dfa010f25b5de

Ler como MarkdownBaixar contrato públicoBaixar OpenAPI

Visão geral

Consulte o plano real da organização, os preços derivados das faturas e as alterações pendentes no contexto do Workspace selecionado e com a autoridade atual do proprietário da organização. Esta consulta não permite resgatar uma oferta nem alterar a cobrança.

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

Autenticação e permissões

Classes de credenciais aceitas
user_session, delegated_oauth, personal_access_token
Capacidade delegada
agent:operate
Função mínima no workspace
Não há função mínima de workspace neste contrato; as verificações de propriedade e permissão continuam valendo.
Escopo de acesso
Recursos que este usuário tem autorização para acessar
Consentimento para todos os workspaces obrigatório
Não
Altera o estado
Não
Quando a operação estiver concluída
synchronous_http_response

Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso.

Campos da requisição

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Campos da requisição
Campo / ramificaçãoTipo / obrigatórioRestrições
$objectObrigatório no objeto pai
  • additionalProperties: false
workspace_idstringObrigatório no objeto pai
  • 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)$"
JSON Schema completo
{
  "$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
}

Resposta e conclusão

Códigos HTTP de sucesso: 200. Quando a operação estiver concluída: synchronous_http_response.

Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado.

Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.

Resposta e conclusão
Campo / ramificaçãoTipo / obrigatórioRestrições
$objectObrigatório no objeto pai—
contract_versionstringObrigatório no objeto pai
  • const: "organization-commercial-billing/v1"
workspace_idstringObrigatório no objeto pai
  • 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_idstringObrigatório no objeto pai
  • 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)$"
planstringObrigatório no objeto pai
  • enum: ["free","founding_pro","pro","team"]
plan_limitsobjectObrigatório no objeto pai—
plan_limitsoneOf 1objectObrigatório no objeto pai—
plan_limits.planoneOf 1stringObrigatório no objeto pai
  • const: "free"
plan_limits.included_human_seatsoneOf 1number | nullObrigatório no objeto pai—
plan_limits.included_human_seatsoneOf 1 / anyOf 1numberObrigatório no objeto pai
  • const: 1
plan_limits.included_human_seatsoneOf 1 / anyOf 2nullObrigatório no objeto pai—
plan_limits.connected_channel_limitoneOf 1numberObrigatório no objeto pai
  • const: 3
plan_limits.successful_destination_publishes_limitoneOf 1number | nullObrigatório no objeto pai—
plan_limits.successful_destination_publishes_limitoneOf 1 / anyOf 1numberObrigatório no objeto pai
  • const: 100
plan_limits.successful_destination_publishes_limitoneOf 1 / anyOf 2nullObrigatório no objeto pai—
plan_limits.pending_scheduled_posts_limitoneOf 1numberObrigatório no objeto pai
  • const: 30
plan_limits.history_daysoneOf 1numberObrigatório no objeto pai
  • const: 30
plan_limits.stripe_quantityoneOf 1numberObrigatório no objeto pai
  • const: 0
plan_limitsoneOf 2objectObrigatório no objeto pai—
plan_limits.planoneOf 2stringObrigatório no objeto pai
  • const: "founding_pro"
plan_limits.included_human_seatsoneOf 2number | nullObrigatório no objeto pai—
plan_limits.included_human_seatsoneOf 2 / anyOf 1numberObrigatório no objeto pai
  • const: 5
plan_limits.included_human_seatsoneOf 2 / anyOf 2nullObrigatório no objeto pai—
plan_limits.connected_channel_limitoneOf 2numberObrigatório no objeto pai—
plan_limits.connected_channel_limitoneOf 2 / anyOf 1numberObrigatório no objeto pai
  • const: 10
plan_limits.connected_channel_limitoneOf 2 / anyOf 2numberObrigatório no objeto pai
  • const: 20
plan_limits.successful_destination_publishes_limitoneOf 2number | nullObrigatório no objeto pai—
plan_limits.successful_destination_publishes_limitoneOf 2 / anyOf 1numberObrigatório no objeto pai
  • const: 1000
plan_limits.successful_destination_publishes_limitoneOf 2 / anyOf 2nullObrigatório no objeto pai—
plan_limits.pending_scheduled_posts_limitoneOf 2numberObrigatório no objeto pai
  • const: 300
plan_limits.history_daysoneOf 2numberObrigatório no objeto pai
  • const: 365
plan_limits.stripe_quantityoneOf 2numberObrigatório no objeto pai
  • const: 1
plan_limitsoneOf 3objectObrigatório no objeto pai—
plan_limits.planoneOf 3stringObrigatório no objeto pai
  • const: "pro"
plan_limits.included_human_seatsoneOf 3nullObrigatório no objeto pai—
plan_limits.connected_channel_limitoneOf 3numberObrigatório no objeto pai
  • const: 10
plan_limits.successful_destination_publishes_limitoneOf 3nullObrigatório no objeto pai—
plan_limits.unlimited_publishing_platformsoneOf 3arrayObrigatório no objeto pai
  • minItems: 4
  • maxItems: 4
plan_limits.pending_scheduled_posts_limitoneOf 3numberObrigatório no objeto pai
  • const: 300
plan_limits.history_daysoneOf 3numberObrigatório no objeto pai
  • const: 365
plan_limits.stripe_quantityoneOf 3numberObrigatório no objeto pai
  • const: 1
plan_limitsoneOf 4objectObrigatório no objeto pai—
plan_limits.planoneOf 4stringObrigatório no objeto pai
  • const: "team"
plan_limits.included_human_seatsoneOf 4nullObrigatório no objeto pai—
plan_limits.connected_channel_limitoneOf 4numberObrigatório no objeto pai
  • const: 20
plan_limits.successful_destination_publishes_limitoneOf 4nullObrigatório no objeto pai—
plan_limits.unlimited_publishing_platformsoneOf 4arrayObrigatório no objeto pai
  • minItems: 4
  • maxItems: 4
plan_limits.pending_scheduled_posts_limitoneOf 4numberObrigatório no objeto pai
  • const: 300
plan_limits.history_daysoneOf 4numberObrigatório no objeto pai
  • const: 365
plan_limits.stripe_quantityoneOf 4numberObrigatório no objeto pai
  • const: 1
pricingobjectObrigatório no objeto pai—
pricingoneOf 1objectObrigatório no objeto pai—
pricingoneOf 1 / oneOf 1objectObrigatório no objeto pai—
pricing.statusoneOf 1 / oneOf 1stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 1 / oneOf 1stringObrigatório no objeto pai
  • const: "standard"
pricing.authorityoneOf 1 / oneOf 1stringObrigatório no objeto pai
  • const: "default_free"
pricing.planoneOf 1 / oneOf 1stringObrigatório no objeto pai
  • const: "free"
pricing.plan_versiononeOf 1 / oneOf 1numberObrigatório no objeto pai—
pricing.plan_versiononeOf 1 / oneOf 1 / anyOf 1numberObrigatório no objeto pai
  • const: 1
pricing.plan_versiononeOf 1 / oneOf 1 / anyOf 2numberObrigatório no objeto pai
  • const: 2
pricing.currencyoneOf 1 / oneOf 1stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 1 / oneOf 1stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 1 / oneOf 1numberObrigatório no objeto pai
  • const: 0
pricingoneOf 1 / oneOf 2objectObrigatório no objeto pai—
pricing.statusoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • const: "standard"
pricing.authorityoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • const: "verified_invoice"
pricing.planoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • const: "pro"
pricing.plan_versiononeOf 1 / oneOf 2numberObrigatório no objeto pai
  • const: 1
pricing.currencyoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 1 / oneOf 2numberObrigatório no objeto pai
  • const: 4000
pricing.verified_periodoneOf 1 / oneOf 2objectObrigatório no objeto pai—
pricing.verified_period.period_startoneOf 1 / oneOf 2stringObrigatório no objeto pai
  • 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 2stringObrigatório no objeto pai
  • 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 3objectObrigatório no objeto pai—
pricing.statusoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • const: "standard"
pricing.authorityoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • const: "verified_invoice"
pricing.planoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • const: "team"
pricing.plan_versiononeOf 1 / oneOf 3numberObrigatório no objeto pai
  • const: 1
pricing.currencyoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 1 / oneOf 3numberObrigatório no objeto pai
  • const: 8000
pricing.verified_periodoneOf 1 / oneOf 3objectObrigatório no objeto pai—
pricing.verified_period.period_startoneOf 1 / oneOf 3stringObrigatório no objeto pai
  • 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 3stringObrigatório no objeto pai
  • 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 2objectObrigatório no objeto pai—
pricingoneOf 2 / oneOf 1objectObrigatório no objeto pai—
pricing.statusoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • const: "promotional"
pricing.authorityoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • const: "verified_invoice"
pricing.planoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • const: "pro"
pricing.plan_versiononeOf 2 / oneOf 1numberObrigatório no objeto pai
  • const: 2
pricing.currencyoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 2 / oneOf 1numberObrigatório no objeto pai
  • const: 1900
pricing.verified_periodoneOf 2 / oneOf 1objectObrigatório no objeto pai—
pricing.verified_period.period_startoneOf 2 / oneOf 1stringObrigatório no objeto pai
  • 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 1stringObrigatório no objeto pai
  • 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 2objectObrigatório no objeto pai—
pricing.statusoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • const: "promotional"
pricing.authorityoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • const: "verified_invoice"
pricing.planoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • const: "team"
pricing.plan_versiononeOf 2 / oneOf 2numberObrigatório no objeto pai
  • const: 2
pricing.currencyoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 2 / oneOf 2numberObrigatório no objeto pai
  • const: 3900
pricing.verified_periodoneOf 2 / oneOf 2objectObrigatório no objeto pai—
pricing.verified_period.period_startoneOf 2 / oneOf 2stringObrigatório no objeto pai
  • 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 2stringObrigatório no objeto pai
  • 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 3objectObrigatório no objeto pai—
pricingoneOf 3 / oneOf 1objectObrigatório no objeto pai—
pricing.statusoneOf 3 / oneOf 1stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 3 / oneOf 1stringObrigatório no objeto pai
  • const: "legacy"
pricing.planoneOf 3 / oneOf 1stringObrigatório no objeto pai
  • const: "founding_pro"
pricing.plan_versiononeOf 3 / oneOf 1integerObrigatório no objeto pai
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.currencyoneOf 3 / oneOf 1stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 3 / oneOf 1stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 3 / oneOf 1integerObrigatório no objeto pai
  • minimum: 0
  • maximum: 2147483647
pricing.authorityoneOf 3 / oneOf 1stringObrigatório no objeto pai
  • const: "legacy_commitment"
pricingoneOf 3 / oneOf 2objectObrigatório no objeto pai—
pricing.statusoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • const: "available"
pricing.source_kindoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • const: "legacy"
pricing.planoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • const: "founding_pro"
pricing.plan_versiononeOf 3 / oneOf 2integerObrigatório no objeto pai
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.currencyoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • const: "usd"
pricing.interval_unitoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • const: "month"
pricing.monthly_amount_centsoneOf 3 / oneOf 2integerObrigatório no objeto pai
  • minimum: 0
  • maximum: 2147483647
pricing.authorityoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • const: "verified_invoice"
pricing.verified_periodoneOf 3 / oneOf 2objectObrigatório no objeto pai—
pricing.verified_period.period_startoneOf 3 / oneOf 2stringObrigatório no objeto pai
  • 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 2stringObrigatório no objeto pai
  • 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 4objectObrigatório no objeto pai—
pricing.statusoneOf 4stringObrigatório no objeto pai
  • const: "unavailable"
pricing.source_kindoneOf 4stringObrigatório no objeto pai
  • const: "manual"
pricing.authorityoneOf 4stringObrigatório no objeto pai
  • const: "manual_grant"
pricing.planoneOf 4stringObrigatório no objeto pai
  • enum: ["free","founding_pro","pro","team"]
pricing.plan_versiononeOf 4integerObrigatório no objeto pai
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.monthly_amount_centsoneOf 4nullObrigatório no objeto pai—
pricing.reason_codeoneOf 4stringObrigatório no objeto pai
  • const: "recurring_charge_not_observed"
pricingoneOf 5objectObrigatório no objeto pai—
pricing.statusoneOf 5stringObrigatório no objeto pai
  • const: "unavailable"
pricing.source_kindoneOf 5stringObrigatório no objeto pai
  • const: "unavailable"
pricing.authorityoneOf 5stringObrigatório no objeto pai
  • const: "not_observed"
pricing.planoneOf 5stringObrigatório no objeto pai
  • enum: ["free","founding_pro","pro","team"]
pricing.plan_versiononeOf 5integer | nullObrigatório no objeto pai—
pricing.plan_versiononeOf 5 / anyOf 1integerObrigatório no objeto pai
  • maximum: 2147483647
  • exclusiveMinimum: 0
pricing.plan_versiononeOf 5 / anyOf 2nullObrigatório no objeto pai—
pricing.monthly_amount_centsoneOf 5nullObrigatório no objeto pai—
pricing.reason_codeoneOf 5stringObrigatório no objeto pai
  • enum: ["current_period_proof_missing","pricing_authority_not_observed","catalog_binding_not_observed"]
purchase_optionsobjectObrigatório no objeto pai—
purchase_optionsoneOf 1objectObrigatório no objeto pai—
purchase_options.statusoneOf 1stringObrigatório no objeto pai
  • const: "unavailable"
purchase_options.reason_codeoneOf 1stringObrigatório no objeto pai
  • enum: ["checkout_disabled","catalog_unconfigured"]
purchase_optionsoneOf 2objectObrigatório no objeto pai—
purchase_options.statusoneOf 2stringObrigatório no objeto pai
  • const: "configured"
purchase_options.catalog_versiononeOf 2stringObrigatório no objeto pai
  • const: "organization-monthly-2026-10-24"
purchase_options.plansoneOf 2objectObrigatório no objeto pai—
purchase_options.plans.prooneOf 2objectObrigatório no objeto pai—
purchase_options.plans.pro.planoneOf 2stringObrigatório no objeto pai
  • const: "pro"
purchase_options.plans.pro.plan_versiononeOf 2numberObrigatório no objeto pai
  • const: 1
purchase_options.plans.pro.currencyoneOf 2stringObrigatório no objeto pai
  • const: "usd"
purchase_options.plans.pro.interval_unitoneOf 2stringObrigatório no objeto pai
  • const: "month"
purchase_options.plans.pro.monthly_amount_centsoneOf 2numberObrigatório no objeto pai
  • const: 4000
purchase_options.plans.teamoneOf 2objectObrigatório no objeto pai—
purchase_options.plans.team.planoneOf 2stringObrigatório no objeto pai
  • const: "team"
purchase_options.plans.team.plan_versiononeOf 2numberObrigatório no objeto pai
  • const: 1
purchase_options.plans.team.currencyoneOf 2stringObrigatório no objeto pai
  • const: "usd"
purchase_options.plans.team.interval_unitoneOf 2stringObrigatório no objeto pai
  • const: "month"
purchase_options.plans.team.monthly_amount_centsoneOf 2numberObrigatório no objeto pai
  • const: 8000
pending_changeobjectObrigatório no objeto pai—
pending_changeoneOf 1objectObrigatório no objeto pai—
pending_change.statusoneOf 1stringObrigatório no objeto pai
  • const: "not_observed"
pending_changeoneOf 2objectObrigatório no objeto pai—
pending_change.statusoneOf 2stringObrigatório no objeto pai
  • enum: ["scheduled","blocked_by_cancellation","terminated"]
pending_change.target_planoneOf 2stringObrigatório no objeto pai
  • enum: ["pro","team"]
pending_change.target_plan_versiononeOf 2numberObrigatório no objeto pai—
pending_change.target_plan_versiononeOf 2 / anyOf 1numberObrigatório no objeto pai
  • const: 1
pending_change.target_plan_versiononeOf 2 / anyOf 2numberObrigatório no objeto pai
  • const: 2
pending_change.source_kindoneOf 2stringObrigatório no objeto pai
  • enum: ["standard","promotional"]
pending_change.currencyoneOf 2stringObrigatório no objeto pai
  • const: "usd"
pending_change.interval_unitoneOf 2stringObrigatório no objeto pai
  • const: "month"
pending_change.monthly_amount_centsoneOf 2numberObrigatório no objeto pai—
pending_change.monthly_amount_centsoneOf 2 / anyOf 1numberObrigatório no objeto pai
  • const: 4000
pending_change.monthly_amount_centsoneOf 2 / anyOf 2numberObrigatório no objeto pai
  • const: 8000
pending_change.monthly_amount_centsoneOf 2 / anyOf 3numberObrigatório no objeto pai
  • const: 1900
pending_change.monthly_amount_centsoneOf 2 / anyOf 4numberObrigatório no objeto pai
  • const: 3900
pending_change.effective_atoneOf 2stringObrigatório no objeto pai
  • 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 2stringObrigatório no objeto pai
  • const: "next_paid_invoice"
pending_changeoneOf 3objectObrigatório no objeto pai—
pending_change.statusoneOf 3stringObrigatório no objeto pai
  • const: "unavailable"
pending_change.reason_codeoneOf 3stringObrigatório no objeto pai
  • const: "pending_change_authority_not_observed"
continuous_lockobjectObrigatório no objeto pai—
continuous_lockoneOf 1objectObrigatório no objeto pai—
continuous_lock.statusoneOf 1stringObrigatório no objeto pai
  • const: "not_observed"
continuous_lockoneOf 2objectObrigatório no objeto pai—
continuous_lock.statusoneOf 2stringObrigatório no objeto pai
  • const: "none"
continuous_lock.reason_codeoneOf 2stringObrigatório no objeto pai
  • const: "standard_subscription"
continuous_lockoneOf 3objectObrigatório no objeto pai—
continuous_lock.statusoneOf 3stringObrigatório no objeto pai
  • const: "active"
continuous_lock.source_kindoneOf 3stringObrigatório no objeto pai
  • const: "promotional"
continuous_lock.currencyoneOf 3stringObrigatório no objeto pai
  • const: "usd"
continuous_lock.interval_unitoneOf 3stringObrigatório no objeto pai
  • const: "month"
continuous_lock.pro_monthly_amount_centsoneOf 3numberObrigatório no objeto pai
  • const: 1900
continuous_lock.team_monthly_amount_centsoneOf 3numberObrigatório no objeto pai
  • const: 3900
continuous_lockoneOf 4objectObrigatório no objeto pai—
continuous_lock.statusoneOf 4stringObrigatório no objeto pai
  • const: "terminated"
continuous_lock.ended_atoneOf 4stringObrigatório no objeto pai
  • 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 5objectObrigatório no objeto pai—
continuous_lock.statusoneOf 5stringObrigatório no objeto pai
  • const: "unavailable"
continuous_lock.reason_codeoneOf 5stringObrigatório no objeto pai
  • const: "commitment_authority_not_observed"
observed_atstringObrigatório no objeto pai
  • 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)))$"
JSON Schema completo
{
  "$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"
  ]
}

Erros e repetições seguras

Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez.

Guia de solução de problemas

Exemplos

Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.

Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais.

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

Exemplo de resposta sintética

{
  "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

Todas as operações da APIAutenticação e permissões