latestOpenAPI 3.1.12026-08-108026304.2 KB
7b222e8ec91c
Discount codes
List discounts
Returns a list of paginated discounts
get/v1/discounts
Query parameters
limitstring
The number of items to retrieve
codestring
A string representing the discount code filter
Response
Successfully returned the list of discounts
Example response
{
"data": [
{
"object": "discount",
"id": "di_123",
"code": "discount_test123",
"expires": {
"date": "2020-05-01",
"formatted": "Fri 1 May 2020 10:30 PM",
"iso": "2020-05-01T22:30:00+01:00",
"time": "22:30",
"timezone": "+01:00",
"unix": 1588368600
},
"max_redemptions": 5,
"name": "Test discount",
"price": 540,
"ticket_types": [
"tt_78",
"tt_123",
"tt_456"
],
"products": [
"pr_78",
"pr_123",
"pr_456"
],
"times_redeemed": 3,
"type": "fixed_amount"
}
],
"links": {
"next": "/v1/discounts?starting_after=di_123",
"previous": "/v1/discounts?ending_before=di_234"
}
}