Stripe: Product catalog schemas

← Product catalog operations · All schemas

Create a trial offer — response body

Field	Type	Presence	Description and constraints
$	object	Root	Trial offers let you define free or paid introductory pricing for a subscription item. A TrialOffer specifies the price to charge during the trial, how many billing intervals the trial lasts, and what price the subscription item transitions to when the trial ends. You attach a TrialOffer to a subscription item using `items[current_trial][trial_offer]` when creating or updating a subscription.
active	boolean	Required within parent	Whether the trial offer is active. Set to false to archive the trial offer.
duration	Model	Required within parent	Expand Create a trial offer — response body — duration
end_behavior	Model	Required within parent	Expand Create a trial offer — response body — end behavior
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`.
nickname	JSON	Optional
nickname (anyOf 1)	string	Alternative	A brief description of the trial offer, hidden from customers. Maximum length: 255
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: product_catalog.trial_offer
price	JSON	Required within parent	The price during the trial offer.
price (anyOf 1)	string	Alternative	Maximum length: 5000
price (anyOf 2)	Model	Alternative	Expand Create a price — response body
price (anyOf 3)	Model	Alternative	Expand Create a trial offer — response body — price / deleted: True, object: price

Referenced models: Create a trial offer — response body — price / deleted: True, object: price, Create a price — response body, Create a trial offer — response body — duration, Create a trial offer — response body — end behavior

Create a trial offer — response body — duration

Field	Type	Presence	Description and constraints
$	object	Root
relative	Model	Optional	Expand Create a trial offer — response body — duration relative
type	string	Required within parent	The type of trial offer duration. Known values: relative

Referenced models: Create a trial offer — response body — duration relative

Create a trial offer — response body — duration relative

Field	Type	Presence	Description and constraints
$	object	Root
iterations	JSON	Required within parent
iterations (anyOf 1)	integer	Alternative	The number of iterations of the price's interval for this trial offer.
iterations (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a trial offer — response body — end behavior

Field	Type	Presence	Description and constraints
$	object	Root
transition	Model	Optional	Expand Create a trial offer — response body — end behavior transition
type	string	Required within parent	The type of behavior when the trial offer ends. Known values: transition

Referenced models: Create a trial offer — response body — end behavior transition

Create a trial offer — response body — end behavior transition

Field	Type	Presence	Description and constraints
$	object	Root
price	JSON	Required within parent	The new price to use at the end of the trial offer period.
price (anyOf 1)	string	Alternative	Maximum length: 5000
price (anyOf 2)	Model	Alternative	Expand Create a price — response body
price (anyOf 3)	Model	Alternative	Expand Create a trial offer — response body — price / deleted: True, object: price

Referenced models: Create a trial offer — response body — price / deleted: True, object: price, Create a price — response body

Create a trial offer — response body — price / deleted: True, object: price

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: price