Skip to main content
GET
List vouchers
Required scope: vouchers:read Rate limit: 300 requests/minute

Pagination

This endpoint supports both cursor pagination (recommended) and page pagination (deprecated). The cursor shape wins if both are sent on the same request. In cursor mode, results are ordered created_at DESC, id DESC, and the sort_by / sort_order params are ignored.

Query parameters

Page shape (deprecated)

The page shape is kept for back-compat. Use cursor pagination for new integrations – see Pagination.

Filters & sorting (both shapes)

Response

Cursor shape:
Page shape (deprecated):
When include=customer is supplied, each voucher additionally carries a customer field:
If a voucher has no linked customer, customer is null.

Errors

  • 400 – Invalid status value, or invalid/forged/cross-tenant cursor.
  • 422include is set to anything other than customer.

Examples