7b222e8ec91c
List vouchers
Returns a list of paginated vouchers
Query parameters
The number of items to retrieve
Unix timestamp filter that returns items with matched expiry_date value.
Unix timestamp filter that returns items with expiry_date greater than the given value.
Unix timestamp filter that returns items with expiry_date greater than or equal to the given value.
Unix timestamp filter that returns items with expiry_date less than given value.
Unix timestamp filter that returns items with expiry_date less than or equal given value.
Unix timestamp filter that returns items with matched created_at value.
Unix timestamp filter that returns items with created_at greater than given value.
Unix timestamp filter that returns items with created_at greater than or equal given value.
Unix timestamp filter that returns items with created_at less than given value.
Unix timestamp filter that returns items with created_at less than or equal given value.
Response
Successfully returned the list of vouchers
Example response
{
"data": [
{
"object": "voucher",
"id": "vo_123",
"available_codes": 7,
"event_series_ids": [
"es_123",
"es_234",
"es_345"
],
"interval": null,
"expiry": {
"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
},
"name": "Test Voucher",
"partial_redemption": "true",
"total_codes": 25,
"type": "PROMO",
"usable_on_any_event": "true",
"value": 540
}
],
"links": {
"next": "/v1/vouchers?starting_after=vo_123",
"previous": "/v1/vouchers?ending_before=vo_234"
}
}