Skip to main content
GET
Retrieve the redemptions of a discount coupon.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

discountCouponUid
string | null
required

The discount coupon's unique identifier

Query Parameters

q
string | null

Searches redemptions by account or plan name

isActive
boolean | null

When set, filters by whether the redemption is still active

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[]