POST /v1/coupons

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.

Servers

https://api.stripe.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name	Type	Required	Description
`duration_in_months`	Integer	No	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.
`percent_off`	Number	No	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).
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`max_redemptions`	Integer	No	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.
`metadata`		No	Set of key-value pairs 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`.
`amount_off`	Integer	No	A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
`currency`	String	No	Three-letter ISO code for the currency of the `amount_off` parameter (required if `amount_off` is passed).
`duration`	String	No	Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`. Possible values: `"repeating"` `"once"` `"forever"`
`id`	String	No	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.
`name`	String	No	Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
`redeem_by`	Integer	No	Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
`currency_options`	Object	No	Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter ISO currency code and a supported currency.
`currency_options.name`	Object	No
`currency_options.name.amount_off`	Integer	Yes
`applies_to`	Object	No	A hash containing directions for what this Coupon will apply discounts to.
`applies_to.products[]`	Array	No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.