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.

Request

Version stringrequired

API Version

Available options2021-04-15

altId stringrequired

Location Id

altType stringrequired

Alt Type

Available optionslocation

limit number

Maximum number of coupons to return

Default value:100

offset number

Number of coupons to skip for pagination

Default value:0

status string

Filter coupons by status

Available optionsscheduledactiveexpired

search string

Search term to filter coupons by name or code

application/json

Successful response

application/json

Schema

Schema

dataobject[]required

Array of coupon objects

totalCountnumberrequired

Total number of coupons matching the query criteria

traceIdstringrequired

Unique identifier for tracing this API request

Example (auto)

{
  "data": [
    {
      "_id": "67f6c132d9485f9dacd5f123",
      "usageCount": 12,
      "limitPerCustomer": 5,
      "altId": "79t07PzK8Tvf73d12312",
      "altType": "location",
      "name": "NEWT6",
      "code": "NEWT6",
      "discountType": "percentage",
      "discountValue": 25,
      "status": "scheduled",
      "startDate": "2025-04-30T18:30:00.000Z",
      "endDate": "2025-05-30T18:30:00.000Z",
      "applyToFuturePayments": true,
      "applyToFuturePaymentsConfig": {
        "type": "fixed",
        "duration": 3,
        "durationType": "months"
      },
      "productIds": [
        "6241712be68f7a98102ba272"
      ],
      "priceIds": [
        "6241712be68f7a98102ba272"
      ],
      "variantIds": [
        "6241712be68f7a98102ba272"
      ],
      "userId": "q0m15dTLGeiGOXG123123",
      "createdAt": "2025-04-09T18:49:22.026Z",
      "updatedAt": "2025-04-09T18:49:22.026Z"
    }
  ],
  "totalCount": 20,
  "traceId": "c667b18d-8f5e-44cf-a914"
}