Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Entitlements

Get customer entitlement

Get entitlement by feature key. For checking entitlement access, use the /value endpoint instead. If featureKey is used, the entitlement is resolved for the current timestamp.

get/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH
entitlementIdOrFeatureKeystring required

Response

The request has succeeded.

OR
OR

Example response

{
  "createdAt": "2024-01-01T01:01:01.001Z",
  "updatedAt": "2024-01-01T01:01:01.001Z",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "activeFrom": "2023-01-01T01:01:01.001Z",
  "activeTo": "2023-01-01T01:01:01.001Z",
  "annotations": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "featureKey": "example-feature-key",
  "featureId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "lastReset": "2023-01-01T01:01:01.001Z",
  "currentUsagePeriod": {
    "from": "2023-01-01T01:01:01.001Z",
    "to": "2023-02-01T01:01:01.001Z"
  },
  "measureUsageFrom": "2023-01-01T01:01:01.001Z",
  "usagePeriod": {
    "interval": "DAY",
    "intervalISO": "P1D",
    "anchor": "2023-01-01T01:01:01.001Z"
  },
  "customerKey": "customer-1",
  "customerId": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
}