Create a coupon

Changed on

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.

post/v1/coupons

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/coupons
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

amount_offinteger

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

currencystring currency

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

currency_optionsobject

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.

duration'forever' | 'once' | 'repeating'

Specifies how long the discount will be in effect if used on a subscription. Defaults to once.

duration_in_monthsinteger

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.

expandstring[]

Specifies which fields in the response should be expanded.

idstring

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_redemptionsinteger

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.

namestring

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_offnumber

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_byinteger

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.

Response

Successful response.

amount_offinteger nullable

Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency nullable

If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.

currency_optionsobject

Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

duration'forever' | 'once' | 'repeating' required

One of forever, once, or repeating. Describes how long a customer who applies this coupon will get the discount.

duration_in_monthsinteger nullable

If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

max_redemptionsinteger nullable

Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.

metadataobject nullable

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.

namestring nullable

Name of the coupon displayed to customers on for instance invoices or receipts.

object'coupon' required

String representing the object's type. Objects of the same type share the same value.

percent_offnumber nullable

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_byinteger nullable

Date after which the coupon can no longer be redeemed.

times_redeemedinteger required

Number of times this coupon has been applied to a customer.

validboolean required

Taking account of the above properties, whether this coupon can still be applied to a customer.

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

  • b22313c11340Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.