Create Coupon

The “Create Coupon” API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to set up promotional offers and special discounts for your customers.

POST https://services.leadconnectorhq.com/payments/coupon

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

string

default:"BQdAwxa0ky1iK2sstLGJ"

required

Account Id

string

default:"account"

required

Alt Type Posibles valores: ‘account’

string

default:"New Year Sale"

required

Coupon Name

string

default:"LEVELUPDAY2022"

required

Coupon Code

string

default:"amount"

required

Discount Type Posibles valores: ‘percentage’, ‘amount’

number

default:"10"

required

Discount Value

string

default:"2023-01-01T22:45:00.000Z"

required

Start date in YYYY-MM-DDTHH:mm:ssZ format

string

default:"2023-01-31T22:45:00.000Z"

End date in YYYY-MM-DDTHH:mm:ssZ format

number

default:"10"

Max number of times coupon can be used

string[]

Product Ids

boolean

default:"True"

Is Coupon applicable on upcoming subscription transactions

object

If coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription

boolean

default:"True"

Limits whether a coupon can be redeemed only once per customer.

Respuestas

201 - Successful response

string

default:"67f6c132d9485f9dacd5f123"

required

Unique MongoDB identifier for the coupon

number

default:"12"

required

Number of times the coupon has been used

number

default:"5"

required

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

string

default:"79t07PzK8Tvf73d12312"

required

Account Id

string

default:"account"

required

Type of entity

string

default:"NEWT6"

required

Display name of the coupon

string

default:"NEWT6"

required

Redemption code for the coupon

string

default:"percentage"

required

Type of discount (percentage or amount) Posibles valores: ‘percentage’, ‘amount’

number

default:"25"

required

Value of the discount (percentage or fixed amount)

string

default:"scheduled"

required

Current status of the coupon Posibles valores: ‘scheduled’, ‘active’, ‘expired’

string

default:"2025-04-30T18:30:00.000Z"

required

Date when the coupon becomes active

string

default:"2025-05-30T18:30:00.000Z"

End date when the coupon expires

boolean

default:"True"

required

Indicates if the coupon applies to future recurring payments

object

required

Configuration for how the coupon applies to future payments

string

default:"q0m15dTLGeiGOXG123123"

User ID associated with the coupon (if applicable)

string

default:"2025-04-09T18:49:22.026Z"

required

Creation timestamp

string

default:"2025-04-09T18:49:22.026Z"

required

Last update timestamp

string

default:"c667b18d-8f5e-44cf-a914"

required

Unique identifier for tracing this API request

{
  "_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

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/payments/coupon' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "altId": "BQdAwxa0ky1iK2sstLGJ",
  "altType": "account",
  "name": "New Year Sale",
  "code": "LEVELUPDAY2022",
  "discountType": "amount",
  "discountValue": 10,
  "startDate": "2023-01-01T22:45:00.000Z",
  "endDate": "2023-01-31T22:45:00.000Z",
  "usageLimit": 10,
  "productIds": [
    "6241712be68f7a98102ba272"
  ],
  "applyToFuturePayments": true,
  "applyToFuturePaymentsConfig": [
    {
      "type": "fixed",
      "duration": 5,
      "durationType": "months"
    },
    {
      "type": "forever"
    }
  ],
  "limitPerCustomer": true
}'

const response = await fetch('https://services.leadconnectorhq.com/payments/coupon', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "name": "New Year Sale", "code": "LEVELUPDAY2022", "discountType": "amount", "discountValue": 10, "startDate": "2023-01-01T22:45:00.000Z", "endDate": "2023-01-31T22:45:00.000Z", "usageLimit": 10, "productIds": ["6241712be68f7a98102ba272"], "applyToFuturePayments": true, "applyToFuturePaymentsConfig": [{"type": "fixed", "duration": 5, "durationType": "months"}, {"type": "forever"}], "limitPerCustomer": true}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/payments/coupon',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"altId": "BQdAwxa0ky1iK2sstLGJ", "altType": "account", "name": "New Year Sale", "code": "LEVELUPDAY2022", "discountType": "amount", "discountValue": 10, "startDate": "2023-01-01T22:45:00.000Z", "endDate": "2023-01-31T22:45:00.000Z", "usageLimit": 10, "productIds": ["6241712be68f7a98102ba272"], "applyToFuturePayments": true, "applyToFuturePaymentsConfig": [{"type": "fixed", "duration": 5, "durationType": "months"}, {"type": "forever"}], "limitPerCustomer": true},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/payments/coupon');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'altId': 'BQdAwxa0ky1iK2sstLGJ', 'altType': 'account', 'name': 'New Year Sale', 'code': 'LEVELUPDAY2022', 'discountType': 'amount', 'discountValue': 10, 'startDate': '2023-01-01T22:45:00.000Z', 'endDate': '2023-01-31T22:45:00.000Z', 'usageLimit': 10, 'productIds': ['6241712be68f7a98102ba272'], 'applyToFuturePayments': true, 'applyToFuturePaymentsConfig': [{'type': 'fixed', 'duration': 5, 'durationType': 'months'}, {'type': 'forever'}], 'limitPerCustomer': true}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo