Retrieve list of coupons
GET {{baseUrl}}/v1/coupons?starting_after=<string>&ending_before=<string>&limit=100
Retrieve a list of all coupons
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
starting_after | string | The ID of the coupon created before the first coupon you want to retrieve | |
ending_before | string | The ID of the coupon created after the last coupon you want to retrieve | |
limit | number | The maximum number of coupons to return. Range is 1-100. Default is 10 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"BTN","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"forever","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":100,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"},{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"MDL","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"forever","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":5,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"}],"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}