Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Query Parameters

featureId
string

Feature ID (refId) to check. Mutually exclusive with currencyId.

Required string length: 1 - 255
currencyId
string

Currency ID (refId) to check for credit entitlements. Mutually exclusive with featureId.

Required string length: 1 - 255
resourceId
string

Resource ID to scope the entitlement check to a specific resource

Required string length: 1 - 255
requestedUsage
integer

Requested usage amount to evaluate against the entitlement limit (numeric features only)

Required range: x >= 0
requestedValues
string[]

Requested values to evaluate against allowed values (enum features only)

reserveAmount
number

Credits to reserve (credit entitlements only). The check is decided and the credits held atomically; requestedUsage is ignored.

Required range: x > 0
reservationId
string

Client-provided reservation ID, required with reserveAmount. Retry with the same ID to get the same result; reuse with different parameters is a conflict.

Required string length: 1 - 255
reservationTtlSeconds
integer

How long the reservation holds the credits, in seconds (1–86400, default 3600). Mutually exclusive with reservationExpiresAt.

Required range: 1 <= x <= 86400
reservationExpiresAt
string<date-time>

When the reservation expires (ISO 8601, at most 24 hours ahead). Mutually exclusive with reservationTtlSeconds.

reservationMetadata
string

JSON-encoded object of string values to attach to the reservation.

Maximum string length: 255

Response

The single entitlement (feature or credit) for the requested customer, including granted status and any access denied reason.

Response object

data
object
required