Sample - Stripe API
GET/v1/plans/{plan}

Retrieve a plan

Retrieves a plan by its unique identifier. Use expand to include expanded related fields in the returned plan object when needed.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
planstringrequired
The unique identifier of the plan to retrieve; it may contain up to 5000 characters.
expandarray<string>optional
Specifies response fields to expand; each field name can contain up to 5000 characters.

2 status codes
200Returns the requested plan object, including its pricing scheme, currency, billing interval, product, and active state.
activebooleanrequired
Whether the plan can be used for new purchases.
amountintegeroptional
The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.
amount_decimalstringoptional
The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.
billing_schemestringrequired
Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.
Allowed:per_unittiered
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
idstringrequired
Unique identifier for the object.
intervalstringrequired
The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
Allowed:daymonthweekyear
interval_countintegerrequired
The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
meterstringoptional
The meter tracking the usage of a metered price
nicknamestringoptional
A brief description of the plan, hidden from customers.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:plan
productstringoptional
The product whose pricing this plan determines.
tiersarray<PlanTier>optional
Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
tiers_modestringoptional
Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.
Allowed:graduatedvolume
transform_usageobjectoptional
Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
trial_period_daysintegeroptional
Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan).
usage_typestringrequired
Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.
Allowed:licensedmetered
defaultReturned when the request cannot be processed; the response contains an error object with a `type` field.
errorobjectrequired

Error handling

plan must identify an existing plan and may contain up to 5000 characters. Each value in expand may contain up to 5000 characters.