Update a coupon
POST / v1 / coupons /:id
Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
Parameters
- metadata map 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 string Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the
idis shown ifnameis not set. The maximum length is 40 characters.
More parameters
- currency _ options map
Returns
The newly updated coupon object if the call succeeded. Otherwise, this call raises an error, such as if the coupon has been deleted.
Response
{ "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}
Retrieve a coupon
GET / v1 / coupons /:id
Retrieves the coupon with the given ID.
Parameters
No parameters.
Returns
Returns a coupon if a valid coupon ID was provided. Raises an error otherwise.
Response
{ "id": "jMT0WJUD", "object": "coupon", "amount_off": null, "created": 1678037688, "currency": null, "duration": "repeating", "duration_in_months": 3, "livemode": false, "max_redemptions": null, "metadata": {}, "name": null, "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true}
List all coupons
GET / v1 / coupons
Returns a list of your coupons.
Parameters
No parameters.
More parameters
- created object
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit coupons, starting after coupon starting_after. Each entry in the array is a separate coupon object. If no more coupons are available, the resulting array will be empty.
Response
{ "object": "list", "url": "/v1/coupons", "has_more": false, "data": [ { "id": "jMT0WJUD", "object": "coupon", "amount_off": null, "created": 1678037688, "currency": null, "duration": "repeating", "duration_in_months": 3, "livemode": false, "max_redemptions": null, "metadata": {}, "name": null, "percent_off": 25.5, "redeem_by": null, "times_redeemed": 0, "valid": true } ]}