Stripe: Prices schemas

← Prices operations · All schemas

Create a price — request body — body currency options value

Field	Type	Presence	Description and constraints
$	object	Root
custom_unit_amount	object	Optional
custom_unit_amount.enabled	boolean	Required within parent
custom_unit_amount.maximum	integer	Optional
custom_unit_amount.minimum	integer	Optional
custom_unit_amount.preset	integer	Optional
tax_behavior	string	Optional	One of: exclusive, inclusive, unspecified
tiers	array	Optional
tiers[]	object	Each item
tiers[].flat_amount	integer	Optional
tiers[].flat_amount_decimal	string	Optional	Format: decimal
tiers[].unit_amount	integer	Optional
tiers[].unit_amount_decimal	string	Optional	Format: decimal
tiers[].up_to	JSON	Required within parent
tiers[].up_to (anyOf 1)	string	Alternative	One of: inf Maximum length: 5000
tiers[].up_to (anyOf 2)	integer	Alternative
unit_amount	integer	Optional
unit_amount_decimal	string	Optional	Format: decimal

Create a price — response body

Field	Type	Presence	Description and constraints
$	object	Root	Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://docs.stripe.com/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).
active	boolean	Required within parent	Whether the price can be used for new purchases.
billing_scheme	string	Required within parent	Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices 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. Known values: per_unit, tiered
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	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). Format: currency
currency_options	object	Optional	Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). Additional keys: see wildcard field
currency_options.*	Model	Additional keys	Expand Create a price — response body — currency options value
custom_unit_amount	JSON	Optional
custom_unit_amount (anyOf 1)	JSON	Alternative	When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
custom_unit_amount (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a price — response body — custom unit amount value maximum, minimum, preset
custom_unit_amount (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
lookup_key	JSON	Optional
lookup_key (anyOf 1)	string	Alternative	A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. Maximum length: 5000
lookup_key (anyOf 2)	null	Alternative
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
nickname	JSON	Optional
nickname (anyOf 1)	string	Alternative	A brief description of the price, hidden from customers. Maximum length: 5000
nickname (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: price
product	JSON	Required within parent	The ID of the product this price is associated with.
product (anyOf 1)	string	Alternative	Maximum length: 5000
product (anyOf 2)	Model	Alternative	Expand Create a product — response body
product (anyOf 3)	Model	Alternative	Expand Delete a product — response body
recurring	JSON	Optional
recurring (anyOf 1)	JSON	Alternative	The recurring components of a price such as `interval` and `usage_type`.
recurring (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a price — response body — recurring / value / interval: day, month, week, year, usage type: licensed, metered
recurring (anyOf 2)	null	Alternative
tax_behavior	JSON	Optional
tax_behavior (anyOf 1)	string	Alternative	Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. Known values: exclusive, inclusive, unspecified
tax_behavior (anyOf 2)	null	Alternative
tiers	array	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[]	Model	Each item	Expand Create a plan — response body — tiers item
tiers_mode	JSON	Optional
tiers_mode (anyOf 1)	string	Alternative	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. Known values: graduated, volume
tiers_mode (anyOf 2)	null	Alternative
transform_quantity	JSON	Optional
transform_quantity (anyOf 1)	JSON	Alternative	Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
transform_quantity (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a plan — response body — transform_usage / value / round: down, up
transform_quantity (anyOf 2)	null	Alternative
type	string	Required within parent	One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Known values: one_time, recurring
unit_amount	JSON	Optional
unit_amount (anyOf 1)	JSON	Alternative
unit_amount (anyOf 1) (anyOf 1)	integer	Alternative	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`.
unit_amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_amount (anyOf 2)	null	Alternative
unit_amount_decimal	JSON	Optional
unit_amount_decimal (anyOf 1)	string	Alternative	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`. Format: decimal
unit_amount_decimal (anyOf 2)	null	Alternative

Referenced models: Create a price — response body — currency options value, Create a price — response body — custom unit amount value maximum, minimum, preset, Delete a product — response body, Create a plan — response body — tiers item, Create a product — response body, Create a price — response body — recurring / value / interval: day, month, week, year, usage type: licensed, metered, Create a plan — response body — transform_usage / value / round: down, up

Create a price — response body — currency options value

Field	Type	Presence	Description and constraints
$	object	Root
custom_unit_amount	JSON	Optional
custom_unit_amount (anyOf 1)	JSON	Alternative	When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
custom_unit_amount (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a price — response body — custom unit amount value maximum, minimum, preset
custom_unit_amount (anyOf 2)	null	Alternative
tax_behavior	JSON	Optional
tax_behavior (anyOf 1)	string	Alternative	Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. Known values: exclusive, inclusive, unspecified
tax_behavior (anyOf 2)	null	Alternative
tiers	array	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[]	Model	Each item	Expand Create a plan — response body — tiers item
unit_amount	JSON	Optional
unit_amount (anyOf 1)	JSON	Alternative
unit_amount (anyOf 1) (anyOf 1)	integer	Alternative	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`.
unit_amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_amount (anyOf 2)	null	Alternative
unit_amount_decimal	JSON	Optional
unit_amount_decimal (anyOf 1)	string	Alternative	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`. Format: decimal
unit_amount_decimal (anyOf 2)	null	Alternative

Referenced models: Create a price — response body — custom unit amount value maximum, minimum, preset, Create a plan — response body — tiers item

Create a price — response body — custom unit amount value maximum, minimum, preset

Field	Type	Presence	Description and constraints
$	object	Root
maximum	JSON	Optional
maximum (anyOf 1)	JSON	Alternative
maximum (anyOf 1) (anyOf 1)	integer	Alternative	The maximum unit amount the customer can specify for this item.
maximum (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum (anyOf 2)	null	Alternative
minimum	JSON	Optional
minimum (anyOf 1)	JSON	Alternative
minimum (anyOf 1) (anyOf 1)	integer	Alternative	The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
minimum (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minimum (anyOf 2)	null	Alternative
preset	JSON	Optional
preset (anyOf 1)	JSON	Alternative
preset (anyOf 1) (anyOf 1)	integer	Alternative	The starting unit amount which can be updated by the customer.
preset (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preset (anyOf 2)	null	Alternative

Create a price — response body — recurring / value / interval: day, month, week, year, usage type: licensed, metered

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. Known values: day, month, week, year
interval_count	JSON	Required within parent
interval_count (anyOf 1)	integer	Alternative	The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
interval_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
meter	JSON	Optional
meter (anyOf 1)	string	Alternative	The meter tracking the usage of a metered price Maximum length: 5000
meter (anyOf 2)	null	Alternative
usage_type	string	Required within parent	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`. Known values: licensed, metered