CouponsVersion: v3
List Coupons
GET/payments/coupon/list
The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers.
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
payments/ coupons. readonlyAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Query Parameters
altIdstringrequired
Location Id
Example:
BQdAwxa0ky1iK2sstLGJaltTypestringrequired
Alt Type
Available options
locationExample:
locationlimitnumber
Maximum number of coupons to return
Default:
100Example:
10offsetnumber
Number of coupons to skip for pagination
Default:
0Example:
0statusstring
Filter coupons by status
Available options
scheduledactiveexpiredExample:
activesearchstring
Search term to filter coupons by name or code
Example:
DEAL50Response
Successful response
dataobject[]required
Array of coupon objects
totalCountnumberrequired
Total number of coupons matching the query criteria
Example:
20traceIdstringrequired
Unique identifier for tracing this API request
Example:
c667b18d-8f5e-44cf-a914