Plan

idstring

slugstring

namestring

descriptionstringnullable

featuresstring[]

priceCentsinteger

Preço de um período. Um plano trimestral de R$ 300 cobra R$ 300 a cada três meses.

currencystring

intervalstring

Unidade do período de cobrança, como o Stripe a define.

Possible values: [day, week, month, year]

intervalCountinteger

Multiplicador da unidade: month com intervalCount: 3 é um plano trimestral.

Default value: 1

billingPeriodstring

Nome 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]

includedNumbersinteger

maxNumbersintegernullable

monthlyMessageLimitintegernullable

trialDaysintegernullable

currentboolean

Só em GET /billing/plans.

billingModelstring

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.

Array [

upTointegernullable

Última quantidade coberta pela faixa; null na última.

unitAmountCentsinteger

flatAmountCentsinteger

]

stackableboolean

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.

property name*integer

maxContactsintegernullable

Tetos do plano para contatos, campos personalizados, destinatários por campanha, assentos da inbox e dias de retenção de mensagens. null é sem teto.

maxContactFieldsintegernullable

maxRecipientsPerBroadcastintegernullable

maxInboxSeatsintegernullable

messageRetentionDaysintegernullable

rateLimits object

Limites por minuto de cada API key neste plano, por categoria. null usa o padrão da plataforma — veja Limites de uso.

sendintegernullable

mediaintegernullable

defaultintegernullable

familystringnullable

Agrupa as variações de período do mesmo plano, como a mensal e a anual.

badgestringnullable

sellableboolean

O plano pode ser comprado agora.

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
}