List customer entitlements

List all entitlements for a customer. For checking entitlement access, use the /value endpoint instead.

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

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

includeDeletedboolean

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

orderBy'createdAt' | 'updatedAt'

Order by options for entitlements.

The order by field.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.