Unique identifier for the coupon. If not provided, Stripe will generate one automatically.
namestring
Name of the coupon displayed to customers on invoices or receipts. Maximum 40 characters.
currencystring
Three-letter ISO currency code in lowercase (e.g., 'usd', 'eur'). Required if amount_off is passed.
durationstring
Specifies how long the discount applies. 'once' applies to a single invoice, 'forever' applies to all invoices indefinitely, 'repeating' applies to invoices for a specified number of months.
metadataobject
Set of key-value pairs for storing additional structured information about the coupon.
redeem_byinteger
Unix timestamp specifying the last time at which the coupon can be redeemed.
amount_offinteger
A positive integer representing the amount to subtract from an invoice total in the smallest currency unit (e.g., cents for USD). Required if percent_off is not passed.
applies_toobject
Specifies which products this coupon applies to.
percent_offnumber
A positive float larger than 0 and smaller or equal to 100 that represents the discount percentage. Required if amount_off is not passed.
max_redemptionsinteger
A positive integer specifying the maximum number of times this coupon can be redeemed before it becomes invalid.
currency_optionsobject
Coupons defined in each available currency option. Each key must be a three-letter ISO currency code.
duration_in_monthsinteger
Required only if duration is 'repeating'. Must be a positive integer specifying the number of months the discount is valid.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not