Skip to main content
Version: 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.

Request​

Version stringrequired

API Version

Available optionsv3
altId stringrequired

Location Id

altType stringrequired

Alt Type

Available optionslocation
id stringrequired

Coupon id

code stringrequired

Coupon code

application/json

Successful response

Schema
    _idstringrequired

    Unique MongoDB identifier for the coupon

    usageCountnumberrequired

    Number of times the coupon has been used

    limitPerCustomernumberrequired

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

    altIdstringrequired

    Location Id

    altTypestringrequired

    Type of entity

    namestringrequired

    Display name of the coupon

    codestringrequired

    Redemption code for the coupon

    discountTypestringrequired

    Type of discount (percentage or amount)

    Available optionspercentageamount
    discountValuenumberrequired

    Value of the discount (percentage or fixed amount)

    statusstringrequired

    Current status of the coupon

    Available optionsscheduledactiveexpired
    startDatestringrequired

    Date when the coupon becomes active

    endDatestring

    End date when the coupon expires

    applyToFuturePaymentsbooleanrequired

    Indicates if the coupon applies to future recurring payments

    applyToFuturePaymentsConfigobjectrequired

    Configuration for how the coupon applies to future payments

    userIdstring

    User ID associated with the coupon (if applicable)

    createdAtstringrequired

    Creation timestamp

    updatedAtstringrequired

    Last update timestamp

    traceIdstringrequired

    Unique identifier for tracing this API request