Update a coupon
Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
Path parameters
Response
Successful response.
Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
Time at which the object was created. Measured in seconds since the Unix epoch.
If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.
Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
One of forever, once, or repeating. Describes how long a customer who applies this coupon will get the discount.
If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
Unique identifier for the object.
If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
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.
Name of the coupon displayed to customers on for instance invoices or receipts.
String representing the object's type. Objects of the same type share the same value.
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.
Date after which the coupon can no longer be redeemed.
Number of times this coupon has been applied to a customer.
Taking account of the above properties, whether this coupon can still be applied to a customer.