v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Governance Entitlements Check

Check entitlement (beta)

Experimental — request and response shapes may change without notice. Same semantics as Check entitlement, plus an optional dimensions query param that resolves to per-entity governance limits surfaced as chains on the response.

get/api/v1-beta/customers/{id}/entitlements/check

Path parameters

idstring required

The unique identifier of the entity

Query parameters

featureIdstring

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

currencyIdstring

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

resourceIdstring

Resource ID to scope the entitlement check to a specific resource

requestedUsageinteger

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

requestedValuesstring[]

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

dimensionsobject

Optional attribution map (e.g. dimensions[userId]=u1). When provided, the response includes a chains array with per-entity governance limits.

Headers

X-ACCOUNT-IDstring

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-IDstring

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).

Response

The single entitlement with optional chains array carrying per-entity governance limits when dimensions was provided.