Skip to main content
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.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

altIdstringrequired

Location Id

Example:BQdAwxa0ky1iK2sstLGJ
altTypestringrequired

Alt Type

Available optionslocation
Example:location
limitnumber

Maximum number of coupons to return

Default:100
Example:10
offsetnumber

Number of coupons to skip for pagination

Default:0
Example:0
statusstring

Filter coupons by status

Available optionsscheduledactiveexpired
Example:active
searchstring

Search term to filter coupons by name or code

Example:DEAL50

Response

Successful response

dataobject[]required

Array of coupon objects

totalCountnumberrequired

Total number of coupons matching the query criteria

Example:20
traceIdstringrequired

Unique identifier for tracing this API request

Example:c667b18d-8f5e-44cf-a914