Create a plan ​
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Returns ​
Returns the plan object.
Parameters ​
currency(enum, required) Three-letter ISO currency code, in lowercase. Must be a supported currency.interval(enum, required) Specifies billing frequency. Eitherday,week,monthoryear. Possible enum values:daymonthweekyear
product(object, required) The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a service product.product.name(string, required) The product’s name, meant to be displayable to the customer.product.active(boolean, optional) Whether the product is currently available for purchase. Defaults totrue.product.metadata(object, optional) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata.product.statement_descriptor(string, optional) An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.This may be up to 22 characters. The statement description may not include
<,>,\,",'characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped.product.tax_code(string, recommended if calculating taxes) A tax code ID.product.tax_details(object, recommended if calculating taxes) Tax details for this product, including the tax code and an optional performance location.product.tax_details.performance_location(string, optional) A tax location ID. Depending on the tax code, this is required, optional, or not supported.product.tax_details.tax_code(string, optional) A tax code ID.
product.unit_label(string, optional) A label that represents units of this product. When set, this will be included in customers’ receipts, invoices, Checkout, and the customer portal.The maximum length is 12 characters.
active(boolean, optional) Whether the plan is currently available for new subscriptions. Defaults totrue.amount(integer, Required unless billing_scheme=tiered) A positive integer in the smallest currency unit (or 0 for a free plan) representing how much to charge on a recurring basis.amount_decimal(string, optional) Same asamount, but accepts a decimal value with at most 12 decimal places. Only one ofamountandamount_decimalcan be set.billing_scheme(enum, optional) Describes how to compute the price per period. Eitherper_unitortiered.per_unitindicates that the fixed amount (specified inamount) will be charged per unit inquantity(for plans withusage_type=licensed), or per unit of total usage (for plans withusage_type=metered).tieredindicates that the unit pricing will be computed using a tiering strategy as defined using thetiersandtiers_modeattributes. Possible enum values:per_unittiered
id(string, optional) An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.interval_count(integer, optional) The number of intervals between subscription billings. For example,interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).metadata(object, optional) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata.meter(string, optional) The meter tracking the usage of a metered pricenickname(string, optional) A brief description of the plan, hidden from customers.tiers(array of objects, Required if billing_scheme=tiered) Each element represents a pricing tier. This parameter requiresbilling_schemeto be set totiered. See also the documentation forbilling_scheme.tiers.up_to(string | integer, required) Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Useinfto define a fallback tier.tiers.flat_amount(integer, optional) The flat billing amount for an entire tier, regardless of the number of units in the tier.tiers.flat_amount_decimal(string, optional) Same asflat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one offlat_amountandflat_amount_decimalcan be set.tiers.unit_amount(integer, optional) The per unit billing amount for each individual unit for which this tier applies.tiers.unit_amount_decimal(string, optional) Same asunit_amount, but accepts a decimal value in the smallest currency unit with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
tiers_mode(enum, Required if billing_scheme=tiered) Defines if the tiering price should begraduatedorvolumebased. Involume-based tiering, the maximum quantity within a period determines the per unit price, ingraduatedtiering pricing can successively change as the quantity grows.transform_usage(object, optional) Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined withtiers.transform_usage.divide_by(integer, required) Divide usage by this number.transform_usage.round(enum, required) After division, either round the resultupordown.
trial_period_days(integer, optional) Default number of trial days when subscribing a customer to this plan usingtrial_from_plan=true.usage_type(enum, optional) Configures how the quantity per period should be determined. Can be eithermeteredorlicensed.licensedautomatically bills thequantityset when adding it to a subscription.meteredaggregates the total usage based on usage records. Defaults tolicensed. Possible enum values:licensedmetered
curl
curl https://api.stripe.com/v1/plans \
-u "<<YOUR_SECRET_KEY>>" \
-d amount=1200 \
-d currency=usd \
-d interval=month \
-d product={{PRODUCT_ID}}Response ​
json
{
"id": "plan_NjpIbv3g3ZibnD",
"object": "plan",
"active": true,
"amount": 1200,
"amount_decimal": "1200",
"billing_scheme": "per_unit",
"created": 1681851647,
"currency": "usd",
"interval": "month",
"interval_count": 1,
"livemode": false,
"metadata": {},
"nickname": null,
"product": "prod_NjpI7DbZx6AlWQ",
"tiers_mode": null,
"transform_usage": null,
"trial_period_days": null,
"usage_type": "licensed"
}