The "List Coupons" API allows you to retrieve a list of all coupons available in your account. Use this endpoint to view all promotional offers and special discounts for your customers.
The "List Coupons" API allows you to retrieve a list of all coupons available in your account. Use this endpoint to view all promotional offers and special discounts for your customers.
http
GET https://services.leadconnectorhq.com/payments/coupon/list
Authorization
Name
Type
Required
Example
Description
Authorization
string
Yes
Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Query parameters
Name
Type
Required
Example
Description
altId
string
Yes
BQdAwxa0ky1iK2sstLGJ
Account Id
altType
string
Yes
account
Alt Type
limit
number
No
10
Maximum number of coupons to return
offset
number
No
0
Number of coupons to skip for pagination
status
string
No
active
Filter coupons by status
search
string
No
DEAL50
Search term to filter coupons by name or code
Responses
200 - Successful response
data (object[], required): Array of coupon objects
_id (string, required): Unique MongoDB identifier for the coupon Example: 67f6c132d9485f9dacd5f123
usageCount (number, required): Number of times the coupon has been used Example: 12
limitPerCustomer (number, required): Maximum number of times a customer can use this coupon (0 for unlimited) Example: 5
altId (string, required): Account Id Example: 79t07PzK8Tvf73d12312
altType (string, required): Type of entity Example: account
name (string, required): Display name of the coupon Example: NEWT6
code (string, required): Redemption code for the coupon Example: NEWT6
discountType (string, required): Type of discount (percentage or amount) Possible values: 'percentage', 'amount' Example: percentage
discountValue (number, required): Value of the discount (percentage or fixed amount) Example: 25
status (string, required): Current status of the coupon Possible values: 'scheduled', 'active', 'expired' Example: scheduled
startDate (string, required): Date when the coupon becomes active Example: 2025-04-30T18:30:00.000Z
endDate (string): End date when the coupon expires Example: 2025-05-30T18:30:00.000Z
applyToFuturePayments (boolean, required): Indicates if the coupon applies to future recurring payments Example: True
applyToFuturePaymentsConfig (object, required): Configuration for how the coupon applies to future payments
userId (string): User ID associated with the coupon (if applicable) Example: q0m15dTLGeiGOXG123123