RevKeen Docs
Api reference

List discounts

Retrieve a paginated list of discounts.

Related endpoints

  • POST /discounts — Create a discount
  • GET /discounts/{id} — Get discount by ID
  • PATCH /discounts/{id} — Update a discount
  • DELETE /discounts/{id} — Delete a discount

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/discounts

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

is_active?string

Filter by active status

Value in"true" | "false"
is_archived?string

Filter by archived status

Value in"true" | "false"
limit?number

Number of results to return (1-100)

Default20
Range1 <= value <= 100
offset?|

Number of results to skip

Default0
Range0 <= value

Response Body

application/json

curl "https://api.revkeen.com/v2/discounts" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "SUMMER20",
      "name": "Summer Sale 20% Off",
      "description": "20% off for summer promotion",
      "discount_type": "percentage",
      "discount_value": 20,
      "applies_to": "all",
      "product_ids": null,
      "max_redemptions": 100,
      "current_redemptions": 25,
      "valid_from": "2024-06-01T00:00:00Z",
      "valid_until": "2024-08-31T23:59:59Z",
      "recurring_type": "once",
      "recurring_cycles": null,
      "first_time_customer": false,
      "is_active": true,
      "created_at": "2024-01-14T08:00:00Z",
      "updated_at": "2024-01-14T08:00:00Z"
    }
  ],
  "meta": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}
Empty
Edit on GitHub