List coupons
A discount the band gives for a reason it has named once — Preferred Planner 5%, Repeat Client 10%, Off-Peak 20%, Showcase Promo 100% of a cocktail line. Stripe’s Coupon. Applied to a gig or a line as a gig_discount, which copies the numbers so the contract never moves when the coupon does.
Query Parameters
- Type: integerlimitmin:0max:200
Page size, 50 by default, 200 at most.
- Type: integeroffsetmin:0
Records to skip.
- Type: stringsort
Comma-separated fields; prefix with
-for descending. Sortable: label, status, percent_off, amount_off, level, applies_to, order, created_time, last_edited_time, id. Default: order,label. - Type: stringfields
Comma-separated subset of fields to return.
idis always included. - filter[label]
Shorthand
filter[label]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.- Type: string
Shorthand
filter[label]=valuemeans equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
- filter[status]
Shorthand
filter[status]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: "active" or "inactive"enum
Shorthand
filter[status]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[percent
_off] Shorthand
filter[percent_off]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.- Type: number
Shorthand
filter[percent_off]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.
- filter[amount
_off] Shorthand
filter[amount_off]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.- Type: number
Shorthand
filter[amount_off]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.
- filter[level]
Shorthand
filter[level]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- Type: "line" or "gig" or "either"enum
Shorthand
filter[level]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.
- filter[applies
_to] Shorthand
filter[applies_to]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.Shorthand
filter[applies_to]=valuemeans equals. Operators: equals, does_not_equal, is_empty, is_not_empty.- additionalPropertyType: anythingproperty
Name
- filter[order]
Shorthand
filter[order]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.- Type: number
Shorthand
filter[order]=valuemeans equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.
- filter[created
_time] Shorthand
filter[created_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: stringFormat: date-time
Shorthand
filter[created_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
- filter[last
_edited _time] Shorthand
filter[last_edited_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.- Type: stringFormat: date-time
Shorthand
filter[last_edited_time]=valuemeans equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
Responses
- application/json
- application/json
- application/json
- application/json
curl 'https://api.weddingoperatingsystems.com/api/v1/coupons?limit=50&offset=0&sort=order%2Clabel' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": null,
"status": "active",
"percent_off": null,
"amount_off": null,
"level": "line",
"applies_to": null,
"order": null,
"created_time": "2026-10-08T19:05:34.886Z",
"last_edited_time": "2026-10-08T19:05:34.886Z"
}
],
"meta": {
"total": 1,
"limit": 1,
"offset": 1
}
}