Stripe: Subscription items schemas

← Subscription items operations · All schemas

Create a subscription item — response body

Field	Type	Presence	Description and constraints
$	object	Root	Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
billed_until	JSON	Optional
billed_until (anyOf 1)	integer	Alternative	The time period the subscription item has been billed for. Format: unix-time
billed_until (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
billing_thresholds	JSON	Optional
billing_thresholds (anyOf 1)	JSON	Alternative	Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
billing_thresholds (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a subscription item — response body — billing thresholds value usage gte
billing_thresholds (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch.
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_period_end	JSON	Required within parent
current_period_end (anyOf 1)	integer	Alternative	The end time of this subscription item's current billing period. Format: unix-time
current_period_end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_period_start	JSON	Required within parent
current_period_start (anyOf 1)	integer	Alternative	The start time of this subscription item's current billing period. Format: unix-time
current_period_start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
current_trial	JSON	Optional
current_trial (anyOf 1)	JSON	Alternative	The current trial that is applied to this subscription item.
current_trial (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a subscription item — response body — current trial value end date, start date, trial offer
current_trial (anyOf 2)	null	Alternative
discounts	array	Required within parent	The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
discounts[]	JSON	Each item
discounts[] (anyOf 1)	string	Alternative	Maximum length: 5000
discounts[] (anyOf 2)	Model	Alternative	Expand Get Customers Customer Discount — response body
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
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
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: subscription_item
price	Model	Required within parent	Expand Create a price — response body
quantity	JSON	Optional
quantity (anyOf 1)	integer	Alternative	The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed.
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subscription	string	Required within parent	The `subscription` this `subscription_item` belongs to. Maximum length: 5000
tax_rates	JSON	Optional
tax_rates (anyOf 1)	array	Alternative	The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
tax_rates (anyOf 1)[]	Model	Each item	Expand Create a tax rate — response body
tax_rates (anyOf 2)	null	Alternative

Referenced models: Get Customers Customer Discount — response body, Create a price — response body, Create a subscription item — response body — billing thresholds value usage gte, Create a subscription item — response body — current trial value end date, start date, trial offer, Create a tax rate — response body

Create a subscription item — response body — billing thresholds value usage gte

Field	Type	Presence	Description and constraints
$	object	Root
usage_gte	JSON	Optional
usage_gte (anyOf 1)	JSON	Alternative
usage_gte (anyOf 1) (anyOf 1)	integer	Alternative	Usage threshold that triggers the subscription to create an invoice
usage_gte (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
usage_gte (anyOf 2)	null	Alternative

Create a subscription item — response body — current trial value end date, start date, trial offer

Field	Type	Presence	Description and constraints
$	object	Root	The current trial attached to the subscription item.
end_date	JSON	Required within parent
end_date (anyOf 1)	integer	Alternative	Format: unix-time
end_date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_date	JSON	Required within parent
start_date (anyOf 1)	integer	Alternative	Format: unix-time
start_date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
trial_offer	string	Required within parent	Maximum length: 5000

Delete a subscription item — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: subscription_item