Plan

idstring

slugstring

namestring

descriptionstringnullable

featuresstring[]

priceCentsinteger

Price of one period. A quarterly plan at $300 charges $300 every three months.

currencystring

intervalstring

Billing period unit, as Stripe defines it.

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

intervalCountinteger

Multiplier on the unit: month with intervalCount: 3 is a quarterly plan.

Default value: 1

billingPeriodstring

Name derived from the interval × intervalCount pair. custom is a period with no name (every four months, for instance).

Possible values: [daily, weekly, monthly, quarterly, semiannual, annual, custom]

includedNumbersinteger

maxNumbersintegernullable

monthlyMessageLimitintegernullable

trialDaysintegernullable

currentboolean

Só em GET /billing/plans.

billingModelstring

flat charges a fixed price per period; per_number, per connected number beyond the included ones; graduated, by tiers (tiers).

Possible values: [flat, per_number, graduated]

tiers object[]

Tiers of the graduated model, in order. Empty for the other models.

Array [

upTointegernullable

Last quantity the tier covers; null on the last one.

unitAmountCentsinteger

flatAmountCentsinteger

]

stackableboolean

A flat plan bought in copies: two numbers on Start become one subscription with two copies, and each copy covers maxNumbers numbers.

currencyPrices object

The price of one period in other currencies, in cents, keyed by the lower-case currency. The base currency is in currency.

property name*integer

maxContactsintegernullable

The plan’s caps on contacts, custom fields, recipients per campaign, inbox seats and message retention days. null means no cap.

maxContactFieldsintegernullable

maxRecipientsPerBroadcastintegernullable

maxInboxSeatsintegernullable

messageRetentionDaysintegernullable

rateLimits object

Per-minute limits of each API key on this plan, by category. null uses the platform default — see Rate limits.

sendintegernullable

mediaintegernullable

defaultintegernullable

familystringnullable

Groups the period variants of the same plan, such as monthly and annual.

badgestringnullable

sellableboolean

The plan can be bought right now.

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
}