Skip to main content

​
Attributes

A plan is a reusable pricing catalog entry. Subscribe a customer to a plan instead of setting amount/frequency directly on the subscription, and every field that defines “how much, how often” is resolved from the plan.
​
string
The unique identifier of the plan (MAX 64; MIN 36).Example: 00000000-0000-4000-8000-000000000001
​
string
The unique identifier of the account the plan belongs to (MAX 64; MIN 36).Example: 00000000-0000-4000-8000-000000000002
​
string
The plan name (MAX 255; MIN 3).Example: Streaming Pro
​
string
The plan description. No length limit is currently enforced.Example: Access to Pro features, billed monthly
​
string
Your own identifier for the plan. No length limit is currently enforced.Example: streaming-pro-monthly
​
enum
Status of the plan.Possible values:
  • ACTIVE = The plan can be subscribed to.
  • CANCELED = The plan no longer accepts new subscriptions. Canceling a plan also cancels every subscription currently linked to it.
​
object
The default price charged in any country without an explicit entry in country_prices.
​
object
The billing frequency for the plan. Every subscription created from this plan inherits it — do not send frequency when subscribing with a plan_id.
​
array of objects
Explicit per-country prices. A country not listed here falls back to base_amount.
​
array of strings
Payment method types accepted for subscriptions on this plan.Example: ["CARD", "PIX"]
​
array of objects
Key-value pairs attached to the plan itself. This is independent of any metadata set directly on a subscription — see the Subscription object for that.
​
array of objects
An optional leading ladder of phases (for example, a trial) before the plan’s regular price applies. Omit for a flat plan with no trial.
​
int
The number of live subscriptions (in any non-terminal status) currently on this plan. This is the set a cancel would affect.Example: 12
Only returned by List Plans — not present on Create Plan or Retrieve Plan responses.
​
array of strings
Sorted ISO α2 codes — the distinct union of every country this plan explicitly prices, at the plan level or inside any phase. An empty array means the plan applies globally via base_amount, not that it has no coverage.
Only returned by List Plans — not present on Create Plan or Retrieve Plan responses.
​
Timestamp
​
Timestamp