Skip to main content
GET
Retrieve all discount coupons.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Query Parameters

canRedeem
boolean
default:false

When true, returns only coupons that can still be redeemed

q
string | null

Searches coupons by name or code

planUid
string | null

Returns only coupons that apply to the plan with this unique identifier

limit
integer
default:25

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offset
integer
default:0

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

metadata
object
items
object[]