Update a coupon

Changed on

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

post/v1/coupons/{coupon}

Request

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

Path parameters

couponstring required

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.

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.