Sample - Stripe API
POST/v1/coupons

Create a coupon

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

13 body fields
amount_offintegeroptional
A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
applies_toobjectoptional
A hash containing directions for what this Coupon will apply discounts to.
currencystringoptional
Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
currency_optionsobjectoptional
Coupons defined in each available currency option (only supported if `amount_off` is passed). 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).
durationstringoptional
Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
Allowed:foreveroncerepeating
duration_in_monthsintegeroptional
Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
expandarray<string>optional
Specifies which fields in the response should be expanded.
idstringoptional
Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
max_redemptionsintegeroptional
A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
metadataobjectoptional
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
namestringoptional
Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
percent_offnumberoptional
A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
redeem_byintegeroptional
Unix timestamp specifying the last time at which the coupon can be redeemed (cannot be set to more than 5 years in the future). After the redeem_by date, the coupon can no longer be applied to new customers.

2 status codes
200Successful response.
amount_offintegeroptional
Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
applies_toobjectoptional
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringoptional
If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
currency_optionsobjectoptional
Coupons 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).
durationstringrequired
One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.
Allowed:foreveroncerepeating
duration_in_monthsintegeroptional
If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
max_redemptionsintegeroptional
Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
metadataobjectoptional
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.
namestringoptional
Name of the coupon displayed to customers on for instance invoices or receipts.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:coupon
percent_offnumberoptional
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
redeem_byintegeroptional
Date after which the coupon can no longer be redeemed.
times_redeemedintegerrequired
Number of times this coupon has been applied to a customer.
validbooleanrequired
Taking account of the above properties, whether this coupon can still be applied to a customer.
defaultError response.
errorobjectrequired

Error handling

Any other status is an error: Error response.