Coupon
List coupons
This endpoint returns a list of all coupons for an account in a list format.
The list of coupons is ordered starting from the most recently created coupon. The response also includes pagination_metadata, which lets the caller retrieve the next page of results if they exist.
get/coupons
Query parameters
limitinteger
The number of items to fetch. Defaults to 20.
cursorstring nullable
Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
show_archivedboolean nullable
Show archived coupons as well (by default, this endpoint only returns active coupons).
redemption_codestring nullable
Filter to coupons matching this redemption code.
Response
OK
Example response
{
"data": [
{
"id": "7iz2yanVjQoBZhyH",
"redemption_code": "HALFOFF",
"discount": {
"applies_to_price_ids": [
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
],
"percentage_discount": 0.15
},
"duration_in_months": 12
}
]
}