Skip to main content
CouponsVersion: v3

Fetch Coupon

GET/payments/coupon

The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods, and other promotional details.

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
idstringrequired

Coupon id

Example:6241712be68f7a98102ba272
codestringrequired

Coupon code

Example:DEAL50

Response

Successful response

_idstringrequired

Unique MongoDB identifier for the coupon

Example:67f6c132d9485f9dacd5f123
usageCountnumberrequired

Number of times the coupon has been used

Example:12
limitPerCustomernumberrequired

Maximum number of times a customer can use this coupon (0 for unlimited)

Example:5
altIdstringrequired

Location Id

Example:79t07PzK8Tvf73d12312
altTypestringrequired

Type of entity

Example:location
namestringrequired

Display name of the coupon

Example:NEWT6
codestringrequired

Redemption code for the coupon

Example:NEWT6
discountTypestringrequired

Type of discount (percentage or amount)

Available optionspercentageamount
Example:percentage
discountValuenumberrequired

Value of the discount (percentage or fixed amount)

Example:25
statusstringrequired

Current status of the coupon

Available optionsscheduledactiveexpired
Example:scheduled
startDatestringrequired

Date when the coupon becomes active

Example:2025-04-30T18:30:00.000Z
endDatestring

End date when the coupon expires

Example:2025-05-30T18:30:00.000Z
applyToFuturePaymentsbooleanrequired

Indicates if the coupon applies to future recurring payments

Example:true
applyToFuturePaymentsConfigobjectrequired

Configuration for how the coupon applies to future payments

userIdstring

User ID associated with the coupon (if applicable)

Example:q0m15dTLGeiGOXG123123
createdAtstringrequired

Creation timestamp

Example:2025-04-09T18:49:22.026Z
updatedAtstringrequired

Last update timestamp

Example:2025-04-09T18:49:22.026Z
traceIdstringrequired

Unique identifier for tracing this API request

Example:c667b18d-8f5e-44cf-a914