RevKeenDocs
StatusSupport
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 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

GET
/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 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.

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.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

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)

Range1 <= value <= 100
Default20
offset?|

Number of results to skip

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/discounts" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "code": "string",      "name": "string",      "description": "string",      "discount_type": "string",      "discount_value": 0,      "applies_to": "string",      "product_ids": [        "string"      ],      "max_redemptions": 0,      "current_redemptions": 0,      "valid_from": "string",      "valid_until": "string",      "recurring_type": "string",      "recurring_cycles": 0,      "first_time_customer": true,      "is_active": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0,    "has_more": true  }}

Get discount by ID GET

Retrieve a single discount by its ID. --- **Related endpoints** - `GET /discounts` — List discounts - `POST /discounts` — Create a discount - `PATCH /discounts/{id}` — Update a discount - `DELETE /discounts/{id}` — Delete a discount **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.

Update a discount PATCH

Update an existing discount. Note: discount code and type cannot be changed. --- **Related endpoints** - `GET /discounts` — List discounts - `POST /discounts` — Create a discount - `GET /discounts/{id}` — Get discount by ID - `DELETE /discounts/{id}` — Delete a discount **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).