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 } ]}

Delete a coupon

DELETE / v1 / coupons /:id

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

Parameters

No parameters.

Returns

An object with the deleted coupon’s ID and a deleted flag upon success. Otherwise, this call raises an error, such as if the coupon has already been deleted.

Response

{ "id": "jMT0WJUD", "object": "coupon", "deleted": true}