BillingOverview
subscriptions object[]
Todas as assinaturas da conta, cada uma com as ações que permite. Uma conta pode ter mais de uma: as vagas compradas se somam.
stripeactivePossible values: [checkout, admin, stripe_import, legacy, license]
Possible values: [licensed, metered]
plan objectnullable
Números cobertos por uma assinatura comprada por vagas (quantityMode: licensed). null nas medidas pelo uso (metered).
pendingChange objectnullable
Mudança agendada — um downgrade vale no fim do período pago.
Possible values: [upgrade, downgrade]
card objectnullable
actions object
O que o painel permite fazer com esta assinatura agora. As ações exigem a sessão do dono da conta — uma API key recebe 403 owner_required.
account object
O lado da conta no gateway: uma moeda e um cartão padrão para todas as assinaturas.
card objectnullable
subscription objectdeprecated
Formato antigo, de assinatura única. Fica por compatibilidade; use subscriptions.
plan object
Preço de um período. Um plano trimestral de R$ 300 cobra R$ 300 a cada três meses.
Unidade do período de cobrança, como o Stripe a define.
Possible values: [day, week, month, year]
Multiplicador da unidade: month com intervalCount: 3 é um plano trimestral.
1Nome derivado do par interval × intervalCount. custom é um período sem nome (por exemplo, a cada quatro meses).
Possible values: [daily, weekly, monthly, quarterly, semiannual, annual, custom]
Só em GET /billing/plans.
flat cobra um preço fixo por período; per_number, por número conectado além dos incluídos; graduated, por faixas (tiers).
Possible values: [flat, per_number, graduated]
tiers object[]
Faixas do modelo graduated, em ordem. Vazio nos outros modelos.
Última quantidade coberta pela faixa; null na última.
Plano fixo que se compra em cópias: dois números no Start viram uma assinatura com duas cópias, e cada cópia cobre maxNumbers números.
currencyPrices object
Preço de um período em outras moedas, em centavos, pela moeda em minúsculas. A moeda base está em currency.
Tetos do plano para contatos, campos personalizados, destinatários por campanha, assentos da inbox e dias de retenção de mensagens. null é sem teto.
rateLimits object
Limites por minuto de cada API key neste plano, por categoria. null usa o padrão da plataforma — veja Limites de uso.
Agrupa as variações de período do mesmo plano, como a mensal e a anual.
O plano pode ser comprado agora.
access object
grace ainda passa, com o header X-Joinotify-Billing-Warning; blocked responde 402.
Possible values: [ok, grace, blocked]
numbers object
O teto de números em vigor. maxSource diz de onde vem: o plano, o período de teste ou uma decisão da operação.
Possible values: [plan, trial, override]
entitlements object[]
Possible values: [active, expired, revoked, invalid]
usage objectnullable
{
"enabled": true,
"subscriptions": [
{
"id": "string",
"provider": "stripe",
"status": "active",
"origin": "checkout",
"quantityMode": "licensed",
"plan": {
"slug": "string",
"name": "string",
"family": "string",
"interval": "string",
"intervalCount": 0,
"billingModel": "string"
},
"numbers": 0,
"amountCents": 0,
"currency": "string",
"trialEndsAt": "2024-07-29T15:51:28.071Z",
"currentPeriodEnd": "2024-07-29T15:51:28.071Z",
"cancelAtPeriodEnd": true,
"pausedUntil": "2024-07-29T15:51:28.071Z",
"pendingUpdate": true,
"pendingChange": {
"kind": "upgrade",
"planSlug": "string",
"planName": "string",
"numbers": 0,
"effectiveAt": "2024-07-29T15:51:28.071Z"
},
"card": {
"brand": "string",
"last4": "string"
},
"actions": {
"change": true,
"cancel": true,
"resume": true,
"endTrial": true,
"cancelPendingChange": true,
"pause": true,
"unpause": true
}
}
],
"account": {
"currency": "string",
"card": {
"brand": "string",
"last4": "string"
}
},
"plan": {
"id": "string",
"slug": "string",
"name": "string",
"description": "string",
"features": [
"string"
],
"priceCents": 0,
"currency": "string",
"interval": "day",
"intervalCount": 1,
"billingPeriod": "daily",
"includedNumbers": 0,
"maxNumbers": 0,
"monthlyMessageLimit": 0,
"trialDays": 0,
"current": true,
"billingModel": "flat",
"tiers": [
{
"upTo": 0,
"unitAmountCents": 0,
"flatAmountCents": 0
}
],
"stackable": true,
"currencyPrices": {
"usd": 799,
"eur": 749
},
"maxContacts": 0,
"maxContactFields": 0,
"maxRecipientsPerBroadcast": 0,
"maxInboxSeats": 0,
"messageRetentionDays": 0,
"rateLimits": {
"send": 0,
"media": 0,
"default": 0
},
"family": "string",
"badge": "string",
"sellable": true
},
"access": {
"state": "ok",
"reason": "string",
"graceEndsAt": "2024-07-29T15:51:28.071Z"
},
"numbers": {
"connected": 0,
"free": 0,
"planIncluded": 0,
"included": 0,
"billable": 0,
"max": 0,
"maxSource": "plan"
},
"entitlements": [
{
"product": "string",
"status": "active",
"includedNumbers": 0,
"expiresAt": "2024-07-29T15:51:28.071Z"
}
],
"trialDays": 0,
"usage": {
"messages": 0,
"limit": 0
}
}