List Discounts

curl -X GET "https://api.chariow.com/v1/discounts?status=active&per_page=20" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/discounts?status=active&per_page=20', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});
const { data, pagination } = await response.json();

$ch = curl_init('https://api.chariow.com/v1/discounts?status=active&per_page=20');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$result = json_decode($response, true);

import requests

response = requests.get(
    'https://api.chariow.com/v1/discounts',
    params={'status': 'active', 'per_page': 20},
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
discounts = response.json()['data']

{
  "data": [
    {
      "id": "dis_abc123",
      "name": "Summer Sale",
      "code": "SUMMER20",
      "type": "percentage",
      "status": "active",
      "value_off": {
        "raw": 20,
        "formatted": "20%"
      },
      "products": [
        {
          "id": "prd_def456",
          "name": "Premium Course",
          "type": "course",
          "pictures": {
            "thumbnail": "https://cdn.chariow.com/thumb.jpg",
            "cover": "https://cdn.chariow.com/cover.jpg"
          },
          "category": {
            "value": "education_and_learning",
            "label": "Education and Learning"
          },
          "pricing": {
            "type": "one_time",
            "price": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            },
            "effective": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            }
          },
          "bundle": null,
          "metadata": null
        }
      ],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": null,
      "usage_limit": 100,
      "usage_limit_per_customer": 1,
      "usage_count": 15,
      "start_date": "2025-01-01T00:00:00+00:00",
      "end_date": "2025-12-31T23:59:59+00:00",
      "is_auto_generated": false,
      "created_at": "2025-01-01T00:00:00+00:00",
      "updated_at": "2025-01-15T10:30:00+00:00"
    },
    {
      "id": "dis_def456abc",
      "name": "VIP Discount",
      "code": "VIP50",
      "type": "fixed",
      "status": "active",
      "value_off": {
        "raw": 50,
        "formatted": "$50.00"
      },
      "products": [],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": "vip@example.com",
      "usage_limit": 1,
      "usage_limit_per_customer": null,
      "usage_count": 0,
      "start_date": null,
      "end_date": null,
      "is_auto_generated": false,
      "created_at": "2025-01-10T08:00:00+00:00",
      "updated_at": "2025-01-10T08:00:00+00:00"
    }
  ],
  "pagination": {
    "count": 2,
    "path": "https://api.chariow.com/v1/discounts",
    "per_page": 20,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

curl -X GET "https://api.chariow.com/v1/discounts?status=active&per_page=20" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/discounts?status=active&per_page=20', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});
const { data, pagination } = await response.json();

$ch = curl_init('https://api.chariow.com/v1/discounts?status=active&per_page=20');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$result = json_decode($response, true);

import requests

response = requests.get(
    'https://api.chariow.com/v1/discounts',
    params={'status': 'active', 'per_page': 20},
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
discounts = response.json()['data']

{
  "data": [
    {
      "id": "dis_abc123",
      "name": "Summer Sale",
      "code": "SUMMER20",
      "type": "percentage",
      "status": "active",
      "value_off": {
        "raw": 20,
        "formatted": "20%"
      },
      "products": [
        {
          "id": "prd_def456",
          "name": "Premium Course",
          "type": "course",
          "pictures": {
            "thumbnail": "https://cdn.chariow.com/thumb.jpg",
            "cover": "https://cdn.chariow.com/cover.jpg"
          },
          "category": {
            "value": "education_and_learning",
            "label": "Education and Learning"
          },
          "pricing": {
            "type": "one_time",
            "price": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            },
            "effective": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            }
          },
          "bundle": null,
          "metadata": null
        }
      ],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": null,
      "usage_limit": 100,
      "usage_limit_per_customer": 1,
      "usage_count": 15,
      "start_date": "2025-01-01T00:00:00+00:00",
      "end_date": "2025-12-31T23:59:59+00:00",
      "is_auto_generated": false,
      "created_at": "2025-01-01T00:00:00+00:00",
      "updated_at": "2025-01-15T10:30:00+00:00"
    },
    {
      "id": "dis_def456abc",
      "name": "VIP Discount",
      "code": "VIP50",
      "type": "fixed",
      "status": "active",
      "value_off": {
        "raw": 50,
        "formatted": "$50.00"
      },
      "products": [],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": "vip@example.com",
      "usage_limit": 1,
      "usage_limit_per_customer": null,
      "usage_count": 0,
      "start_date": null,
      "end_date": null,
      "is_auto_generated": false,
      "created_at": "2025-01-10T08:00:00+00:00",
      "updated_at": "2025-01-10T08:00:00+00:00"
    }
  ],
  "pagination": {
    "count": 2,
    "path": "https://api.chariow.com/v1/discounts",
    "per_page": 20,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

Retrieves a cursor-paginated list of all discount codes in your store, newest first, with optional filtering and search capabilities.

Required scope: discounts.read. A key without it receives a 403 error. See Authentication.

Query Parameters

integer

default:"10"

Number of discounts to return per page (max 100)

string

Cursor for pagination. Use the next_cursor from the previous response.

string

Filter by status (active, expired)

string

Search by discount code, name, or public ID

string

Only discounts created on or after this date (Y-m-d, e.g., 2025-01-01). Send it together with to.

string

Only discounts created on or before this date (Y-m-d, e.g., 2025-01-31). Send it together with from.

string

Preset creation date range, used instead of from and to: today, yesterday, last7days, last30days, thisWeek, lastWeek, thisMonth, lastMonth, thisYear, lastYear

Response

The list is returned at the top level of the body, without the message and errors fields used by error responses.

array

Array of discount objects, newest first

Show discount object

string

Unique discount identifier (e.g., dis_abc123)

string

Display name of the discount

string

The discount code customers use at checkout

string

Discount type (percentage or fixed)

string

Discount status (active or expired)

object

Discount value information

Show properties

number

Raw discount value (percentage number or amount in currency units)

string

Human-readable formatted value (e.g., 20% or $10.00)

array

Products this discount applies to (empty if it applies to all products)

Show product object

string

Product public ID

string

Product name

string

Product type

object

thumbnail and cover image URLs (each null when not set)

object

Category value and label

object

Pricing type, price and effective amounts, in the product currency

object | null

Bundle value and savings, or null unless the product is a bundle

object | null

Custom metadata set on the product

object

Store information: id, name, logo_url and url

string | null

Email of the customer this discount is restricted to (null if no restriction)

integer | null

Maximum number of uses in total (null if unlimited)

integer | null

Maximum number of uses per customer (null if unlimited)

integer

Number of times the discount has been used

string | null

ISO 8601 timestamp when the discount becomes active (null if no start restriction)

string | null

ISO 8601 timestamp when the discount expires (null if no expiration)

boolean

Whether the discount was automatically generated by the system

string

ISO 8601 timestamp when the discount was created

string

ISO 8601 timestamp when the discount was last updated

object

Cursor pagination metadata

Show pagination object

integer

Number of items on this page

string

Base URL of the endpoint

integer

Page size used for this request

string | null

Cursor for the next page, or null if there are no more pages

string | null

Full URL of the next page, or null

string | null

Cursor for the previous page, or null on the first page

string | null

Full URL of the previous page, or null

boolean

Whether there are more items to fetch

boolean

Whether the results span more than one page

curl -X GET "https://api.chariow.com/v1/discounts?status=active&per_page=20" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/discounts?status=active&per_page=20', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});
const { data, pagination } = await response.json();

$ch = curl_init('https://api.chariow.com/v1/discounts?status=active&per_page=20');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$result = json_decode($response, true);

import requests

response = requests.get(
    'https://api.chariow.com/v1/discounts',
    params={'status': 'active', 'per_page': 20},
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
discounts = response.json()['data']

{
  "data": [
    {
      "id": "dis_abc123",
      "name": "Summer Sale",
      "code": "SUMMER20",
      "type": "percentage",
      "status": "active",
      "value_off": {
        "raw": 20,
        "formatted": "20%"
      },
      "products": [
        {
          "id": "prd_def456",
          "name": "Premium Course",
          "type": "course",
          "pictures": {
            "thumbnail": "https://cdn.chariow.com/thumb.jpg",
            "cover": "https://cdn.chariow.com/cover.jpg"
          },
          "category": {
            "value": "education_and_learning",
            "label": "Education and Learning"
          },
          "pricing": {
            "type": "one_time",
            "price": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            },
            "effective": {
              "value": 99,
              "formatted": "$99.00",
              "short": "99",
              "currency": "USD"
            }
          },
          "bundle": null,
          "metadata": null
        }
      ],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": null,
      "usage_limit": 100,
      "usage_limit_per_customer": 1,
      "usage_count": 15,
      "start_date": "2025-01-01T00:00:00+00:00",
      "end_date": "2025-12-31T23:59:59+00:00",
      "is_auto_generated": false,
      "created_at": "2025-01-01T00:00:00+00:00",
      "updated_at": "2025-01-15T10:30:00+00:00"
    },
    {
      "id": "dis_def456abc",
      "name": "VIP Discount",
      "code": "VIP50",
      "type": "fixed",
      "status": "active",
      "value_off": {
        "raw": 50,
        "formatted": "$50.00"
      },
      "products": [],
      "store": {
        "id": "store_xyz789",
        "name": "My Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.mychariow.com"
      },
      "customer_email": "vip@example.com",
      "usage_limit": 1,
      "usage_limit_per_customer": null,
      "usage_count": 0,
      "start_date": null,
      "end_date": null,
      "is_auto_generated": false,
      "created_at": "2025-01-10T08:00:00+00:00",
      "updated_at": "2025-01-10T08:00:00+00:00"
    }
  ],
  "pagination": {
    "count": 2,
    "path": "https://api.chariow.com/v1/discounts",
    "per_page": 20,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null,
    "has_more_pages": false,
    "has_pages": false
  }
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Query Parameters

Response

​Query Parameters

​Response

Query Parameters

Response