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.

http
GET https://services.leadconnectorhq.com/payments/coupon

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Query parameters

NameTypeRequiredExampleDescription
altIdstringYesBQdAwxa0ky1iK2sstLGJAccount Id
altTypestringYesaccountAlt Type
idstringYes6241712be68f7a98102ba272Coupon id
codestringYesDEAL50Coupon code

Responses

200 - Successful response
  • _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

  • createdAt (string, required): Creation timestamp Example: 2025-04-09T18:49:22.026Z

  • updatedAt (string, required): Last update timestamp Example: 2025-04-09T18:49:22.026Z

  • traceId (string, required): Unique identifier for tracing this API request Example: c667b18d-8f5e-44cf-a914

json
{
  "_id": "67f6c132d9485f9dacd5f123",
  "usageCount": 12,
  "limitPerCustomer": 5,
  "altId": "79t07PzK8Tvf73d12312",
  "altType": "account",
  "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,
  "userId": "q0m15dTLGeiGOXG123123",
  "createdAt": "2025-04-09T18:49:22.026Z",
  "updatedAt": "2025-04-09T18:49:22.026Z",
  "traceId": "c667b18d-8f5e-44cf-a914"
}
422 - Unprocessable Entity
json
{}

Example

curl -X GET 'https://services.leadconnectorhq.com/payments/coupon' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?