Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
Parameters
- metadataobject
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
. - namestring
Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the
id
is shown ifname
is not set.
More parameters
- currency_
optionsobject Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter ISO currency code and a supported currency.
- currency_options.
<currency>. amount_ offintegerRequired A positive integer representing the amount to subtract from an invoice total.
Returns
The newly updated coupon object if the call succeeded. Otherwise, this call raises an error, such as if the coupon has been deleted.
{ "id": "jMT0WJUD", "object": "coupon", "amount_off": null, "created": 1678037688, "currency": null, "duration": "repeating", "duration_in_months": 3, "livemode": false, "max_redemptions": null, "metadata": { "order_id": "6735" }, "name": null, "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true}