RevKeenDocs
StatusSupport
API Reference

Check customer entitlement

Check if a customer has access to a specific benefit by key. This is the primary endpoint for feature gating and licensing checks. --- **Related endpoints** - `GET /customers/{customerId}/entitlements` — List customer entitlements - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID - `GET /entitlements` — List entitlements - `GET /entitlements/check` — Check entitlement access **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.

GET
/customers/{customerId}/entitlements/check

Check if a customer has access to a specific benefit by key. This is the primary endpoint for feature gating and licensing checks.

Related endpoints

  • GET /customers/{customerId}/entitlements — List customer entitlements
  • POST /customers/{customerId}/entitlements — Grant entitlement to customer
  • DELETE /customers/{customerId}/entitlements — Revoke entitlement by benefit key
  • DELETE /customers/{customerId}/entitlements/{entitlementId} — Revoke entitlement by ID
  • GET /entitlements — List entitlements
  • GET /entitlements/check — Check entitlement access

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.

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

Path Parameters

customerId*string

Customer UUID

Formatuuid

Query Parameters

benefitKey*string

Benefit key to check

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/customers/00000000-0000-0000-0000-000000000000/entitlements/check?benefitKey=value" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": {    "benefit_key": "string",    "has_access": true,    "access_level": "full",    "status": "active",    "benefit": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "benefit_type": "string",      "benefit_key": "string",      "category": "string",      "icon_url": "string",      "display_order": "string",      "is_active": true,      "default_value": null,      "config": null    },    "reason": "string"  }}

Create a new customer POST

Create a new customer record in the merchant's account --- **Related endpoints** - `GET /customers/{customerId}/invoices` — List customer invoices - `GET /customers/{customerId}/subscriptions` — List customer subscriptions - `GET /customers/{customerId}/orders` — List customer orders - `GET /customers/{customerId}/payments` — List customer payments - `PUT /customers/external/batch` — Batch upsert customers by external ID - `GET /customers` — List customers - `GET /customers/{id}` — Get customer by ID - `PATCH /customers/{id}` — Update customer details **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. **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).

Grant entitlement to customer POST

Grant a benefit/entitlement to a customer. Provide either benefitId or benefitKey to identify the benefit. Emits an entitlement.granted webhook event. --- **Related endpoints** - `GET /customers/{customerId}/entitlements` — List customer entitlements - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID - `GET /entitlements` — List entitlements - `GET /entitlements/check` — Check entitlement access **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).