Skip to main content
GET
/
payments
/
coupon
/
list
List Coupons
curl --request GET \
  --url https://services.leadconnectorhq.com/payments/coupon/list \
  --header 'Version: <version>'
{
  "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",
      "applyToFuturePayments": true,
      "applyToFuturePaymentsConfig": {
        "type": "fixed",
        "duration": 3,
        "durationType": "months"
      },
      "createdAt": "2025-04-09T18:49:22.026Z",
      "updatedAt": "2025-04-09T18:49:22.026Z",
      "endDate": "2025-05-30T18:30:00.000Z",
      "userId": "q0m15dTLGeiGOXG123123"
    }
  ],
  "totalCount": 20,
  "traceId": "c667b18d-8f5e-44cf-a914"
}

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

​
altId
string
required

Location Id

Example:

"BQdAwxa0ky1iK2sstLGJ"

​
altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

​
limit
number
default:100

Maximum number of coupons to return

Example:

10

​
offset
number
default:0

Number of coupons to skip for pagination

Example:

0

​
status
enum<string>

Filter coupons by status

Available options:
scheduled,
active,
expired
Example:

"active"

​
search
string

Search term to filter coupons by name or code

Example:

"DEAL50"

Response

Successful response

​
data
object[]
required

Array of coupon objects

​
totalCount
number
required

Total number of coupons matching the query criteria

Example:

20

​
traceId
string
required

Unique identifier for tracing this API request

Example:

"c667b18d-8f5e-44cf-a914"

Last modified on March 8, 2026