v69

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

Get entitlements state

Retrieves the effective entitlements for a customer or resource, including feature and credit entitlements.

Warning: This REST API endpoint lacks built-in client-side caching, fallback mechanisms, and low-latency guarantees. It is not recommended for hot-path entitlement checks. For production use, consider using the Stigg Node Server SDK with caching or the Sidecar for low-latency cached responses.

get/api/v1/customers/{id}/entitlements

Path parameters

idstring required

The unique identifier of the entity

Query parameters

resourceIdstring

Resource ID to scope entitlements to a specific resource

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 entitlements state including feature and credit entitlements, and an optional access denied reason.