List Coupons - Affonso Docs

curl -X GET "https://api.affonso.io/v1/coupons?limit=10" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "success": true,
  "data": [
    {
      "id": "cpn_abc123",
      "code": "SAVE25",
      "affiliate_id": "aff_123",
      "program_id": "prg_789ghi",
      "discount_type": "percentage",
      "discount_value": 25,
      "duration": "forever",
      "duration_in_months": null,
      "currency": null,
      "product_ids": [],
      "provider": "stripe",
      "provider_coupon_id": "promo_abc123",
      "provider_promo_code_id": "pc_abc123",
      "provider_records": [
        {
          "provider": "stripe",
          "provider_coupon_id": "promo_abc123",
          "provider_promo_code_id": "pc_abc123",
          "created_at": "2024-01-15T10:30:00Z"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

GET

coupons

curl -X GET "https://api.affonso.io/v1/coupons?limit=10" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "success": true,
  "data": [
    {
      "id": "cpn_abc123",
      "code": "SAVE25",
      "affiliate_id": "aff_123",
      "program_id": "prg_789ghi",
      "discount_type": "percentage",
      "discount_value": 25,
      "duration": "forever",
      "duration_in_months": null,
      "currency": null,
      "product_ids": [],
      "provider": "stripe",
      "provider_coupon_id": "promo_abc123",
      "provider_promo_code_id": "pc_abc123",
      "provider_records": [
        {
          "provider": "stripe",
          "provider_coupon_id": "promo_abc123",
          "provider_promo_code_id": "pc_abc123",
          "created_at": "2024-01-15T10:30:00Z"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Query Parameters

page

integer

default:"1"

Page number for pagination. Must be a positive integer.

limit

integer

default:"50"

Number of results per page. Maximum value is 200. Default is 50.

affiliate_id

string

Filter coupons by affiliate ID.

program_id

string

Filter coupons by program ID.

string

Search by coupon code. Case-insensitive partial matching. Maximum 100 characters.

sort

string

Sort field and direction in the format field:direction. Valid fields: created_at, code. Valid directions: asc, desc. Example: created_at:desc.

expand

string

Comma-separated list of related data to include in the response. Valid values: affiliate.

Response

The response includes a paginated list of coupons and pagination metadata.

success

boolean

Always true for successful responses

data

array

Array of coupon objects. Each coupon object has the same structure as the single coupon response (see Get Coupon endpoint).

Show Data Object Properties

string

Unique identifier for the coupon

code

string

The coupon code (always uppercase)

affiliate_id

string

The ID of the affiliate who owns this coupon

program_id

string

The ID of the affiliate program this coupon belongs to

discount_type

string

Type of discount: percentage or fixed

discount_value

number

The discount amount. For percentage: 0-100. For fixed: amount in the specified currency.

duration

string

How long the discount applies: forever, once, or repeating

duration_in_months

integer | null

Number of months the discount repeats (only applicable when duration is repeating)

currency

string | null

Three-letter currency code (only applicable when discount_type is fixed)

product_ids

array

Array of product IDs this coupon is restricted to. Empty array means all products.

provider

string | null

The primary payment provider for this coupon (e.g., stripe, dodo, creem).

provider_coupon_id

string | null

The coupon ID at the primary payment provider.

The promo code ID at the primary payment provider.

provider_records

array

Array of provider-specific coupon records. Each record contains:

provider (string): The payment provider name
provider_coupon_id (string): The coupon ID at this provider
provider_promo_code_id (string): The promo code ID at this provider
created_at (string): ISO 8601 timestamp of when the provider record was created

created_at

string

ISO 8601 timestamp of when the coupon was created

updated_at

string | null

ISO 8601 timestamp of when the coupon was last updated

pagination

object

Pagination metadata object containing:

page (integer): Current page number
limit (integer): Number of results per page
total (integer): Total number of coupons matching the filters
totalPages (integer): Total number of pages
hasNextPage (boolean): Whether there is a next page
hasPrevPage (boolean): Whether there is a previous page

curl -X GET "https://api.affonso.io/v1/coupons?limit=10" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "success": true,
  "data": [
    {
      "id": "cpn_abc123",
      "code": "SAVE25",
      "affiliate_id": "aff_123",
      "program_id": "prg_789ghi",
      "discount_type": "percentage",
      "discount_value": 25,
      "duration": "forever",
      "duration_in_months": null,
      "currency": null,
      "product_ids": [],
      "provider": "stripe",
      "provider_coupon_id": "promo_abc123",
      "provider_promo_code_id": "pc_abc123",
      "provider_records": [
        {
          "provider": "stripe",
          "provider_coupon_id": "promo_abc123",
          "provider_promo_code_id": "pc_abc123",
          "created_at": "2024-01-15T10:30:00Z"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Update Payout Get Coupon

​Query Parameters

​Response

Query Parameters

Response