Get Coupons

Get all coupons or by ID/externalId/name

curl --request GET \
  --url https://www.pushlapgrowth.com/api/v1/coupons \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "externalId": "<string>",
  "couponType": "PERCENTAGE",
  "percentOff": 123,
  "amountOff": 123,
  "currency": "<string>",
  "duration": "once",
  "durationInMonths": 123,
  "maxRedemptions": 123,
  "limitToProducts": true,
  "productIds": [
    "<string>"
  ],
  "valid": true,
  "redeemBy": "2023-11-07T05:31:56Z",
  "integrationType": "<string>",
  "affiliateProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "promotionalCodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "active": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "maxRedemptions": 123,
      "timesRedeemed": 123,
      "firstTimeOrder": true,
      "minimumAmount": 123,
      "minimumAmountCurrency": "<string>",
      "limitToCustomers": true,
      "customerId": "<string>",
      "limitToAffiliate": true,
      "isAutoGenerated": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "coupon": "<unknown>",
      "affiliate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "[email protected]"
      }
    }
  ]
}

GET

coupons

Get all coupons or by ID/externalId/name

curl --request GET \
  --url https://www.pushlapgrowth.com/api/v1/coupons \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "externalId": "<string>",
  "couponType": "PERCENTAGE",
  "percentOff": 123,
  "amountOff": 123,
  "currency": "<string>",
  "duration": "once",
  "durationInMonths": 123,
  "maxRedemptions": 123,
  "limitToProducts": true,
  "productIds": [
    "<string>"
  ],
  "valid": true,
  "redeemBy": "2023-11-07T05:31:56Z",
  "integrationType": "<string>",
  "affiliateProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "promotionalCodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "active": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "maxRedemptions": 123,
      "timesRedeemed": 123,
      "firstTimeOrder": true,
      "minimumAmount": 123,
      "minimumAmountCurrency": "<string>",
      "limitToCustomers": true,
      "customerId": "<string>",
      "limitToAffiliate": true,
      "isAutoGenerated": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "coupon": "<unknown>",
      "affiliate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "[email protected]"
      }
    }
  ]
}

Understanding Coupons

Coupons define the structure and rules for discounts in your affiliate program. They specify:

Discount type (percentage or flat amount)
Discount value (e.g., 20% off or $10 off)
Duration (one-time, forever, or repeating for X months)
Restrictions (product limits, expiration dates, max redemptions)

Think of coupons as the “template” or “definition” of a discount. The actual codes that customers enter at checkout are promotional codes, which are linked to coupons.

Coupons vs Promotional Codes

Coupon: The discount definition (e.g., “20% off for 3 months”)
Promotional Code: The actual code string (e.g., “JOHN20”, “SAVE20”) that customers use

One coupon can have multiple promotional codes associated with it, allowing different affiliates to share the same discount structure with unique codes.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string<uuid>

The ID of the coupon to retrieve

externalId

string

The external ID of the coupon (e.g., Stripe coupon ID)

name

string

The name of the coupon to retrieve

Response

A list of coupons or a single coupon

object
object[]

string<uuid>

The coupon ID

name

string

Name of the coupon

externalId

string | null

External ID (e.g., Stripe coupon ID)

couponType

enum<string>

Type of discount - percentage or flat amount

Available options:

PERCENTAGE,

FLAT

percentOff

number<float> | null

Percentage off (1-100) for percentage coupons

amountOff

number<float> | null

Amount off for flat coupons

currency

string | null

Currency for flat amount coupons (e.g., USD, EUR)

duration

enum<string>

How long the discount applies

Available options:

once,

forever,

repeating

durationInMonths

integer | null

Number of months for repeating duration

maxRedemptions

integer | null

Maximum number of times this coupon can be redeemed

limitToProducts

boolean

Whether coupon is limited to specific products

productIds

string[]

Array of product IDs this coupon applies to

valid

boolean

Whether the coupon is currently valid

redeemBy

string<date-time> | null

Date by which the coupon must be redeemed

integrationType

string | null

Integration type (e.g., stripe, custom)

affiliateProgramId

string<uuid>

The affiliate program ID

createdAt

string<date-time>

Timestamp when the coupon was created

updatedAt

string<date-time>

Timestamp when the coupon was last updated

promotionalCodes

object[]

Promotional codes associated with this coupon

Show child attributes

promotionalCodes.id

string<uuid>

The promotional code ID

promotionalCodes.code

string

The actual promotional code string

promotionalCodes.couponId

string<uuid>

The parent coupon ID

promotionalCodes.affiliateId

string<uuid> | null

The affiliate ID this code is assigned to

promotionalCodes.externalId

string | null

External ID (e.g., Stripe promotion code ID)

promotionalCodes.active

boolean

Whether the promotional code is active

promotionalCodes.expiresAt

string<date-time> | null

Expiration date for the code

promotionalCodes.maxRedemptions

integer | null

Maximum number of times this code can be used

promotionalCodes.timesRedeemed

integer

Number of times this code has been redeemed

promotionalCodes.firstTimeOrder

boolean

Whether this code is limited to first-time orders

promotionalCodes.minimumAmount

number<float> | null

Minimum purchase amount required

promotionalCodes.minimumAmountCurrency

string | null

Currency for minimum amount

promotionalCodes.limitToCustomers

boolean

Whether code is limited to specific customers

promotionalCodes.customerId

string | null

Specific customer ID this code is limited to

promotionalCodes.limitToAffiliate

boolean

Whether only the affiliate can use this code

promotionalCodes.isAutoGenerated

boolean

Whether this code was auto-generated

promotionalCodes.createdAt

string<date-time>

Timestamp when the code was created

promotionalCodes.updatedAt

string<date-time>

Timestamp when the code was last updated

promotionalCodes.affiliate

object

Affiliate details

Show child attributes

promotionalCodes.affiliate.id

string<uuid>

promotionalCodes.affiliate.firstName

string

promotionalCodes.affiliate.lastName

string

promotionalCodes.affiliate.email

string<email>

Update Affiliate Link Create a Coupon

⌘I

API Documentation

Affiliate Endpoints

Referral Endpoints

Sale Endpoints

Affiliate Link Endpoints

Coupon Endpoints

Promotional Code Endpoints

Understanding Coupons

Coupons vs Promotional Codes

Authorizations

Query Parameters

Response

API Documentation

Affiliate Endpoints

Referral Endpoints

Sale Endpoints

Affiliate Link Endpoints

Coupon Endpoints

Promotional Code Endpoints

​Understanding Coupons

​Coupons vs Promotional Codes

Authorizations

Query Parameters

Response

Understanding Coupons

Coupons vs Promotional Codes