A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed)

Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed)

Specifies how long the discount will be in effect if used on a subscription

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.

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.

Name of the coupon displayed to customers on for instance invoices; or receipts. By default the id is shown if name is not set.

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).

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.

A hash containing directions for what this Coupon will apply discounts to.

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. For example; to define your coupon in eur; pass the fields below in the eur key of currency_options.

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.

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.