Skip to main content
GET
https://api.chariow.com/v1
/
discounts
curl -X GET "https://api.chariow.com/v1/discounts?status=active&per_page=20" \
  -H "Authorization: Bearer sk_live_your_api_key"
{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "dis_abc123xyz",
        "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",
              "label": "Education"
            },
            "pricing": {
              "type": "one_time",
              "price": {
                "raw": 99.99,
                "formatted": "$99.99"
              }
            },
            "bundle": null
          }
        ],
        "store": {
          "id": "str_xyz789",
          "name": "My Store"
        },
        "customer_email": null,
        "usage_limit": 100,
        "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": "str_xyz789",
          "name": "My Store"
        },
        "customer_email": "[email protected]",
        "usage_limit": 1,
        "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": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}
Retrieves a cursor-paginated list of all discount codes in your store with optional filtering and search capabilities.

Query Parameters

per_page
integer
default:"15"
Number of discounts to return per page (max 100)
cursor
string
Cursor for pagination. Use the next_cursor from the previous response.
status
string
Filter by status (active, expired)
Search by discount code, name, or public ID
start_date
string
Filter discounts created from this date (Y-m-d format, e.g., 2025-01-01)
end_date
string
Filter discounts created until this date (Y-m-d format, e.g., 2025-01-31)

Response

data
object
curl -X GET "https://api.chariow.com/v1/discounts?status=active&per_page=20" \
  -H "Authorization: Bearer sk_live_your_api_key"
{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "dis_abc123xyz",
        "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",
              "label": "Education"
            },
            "pricing": {
              "type": "one_time",
              "price": {
                "raw": 99.99,
                "formatted": "$99.99"
              }
            },
            "bundle": null
          }
        ],
        "store": {
          "id": "str_xyz789",
          "name": "My Store"
        },
        "customer_email": null,
        "usage_limit": 100,
        "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": "str_xyz789",
          "name": "My Store"
        },
        "customer_email": "[email protected]",
        "usage_limit": 1,
        "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": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}