Check entitlement
Checks a single entitlement (feature or credit) for a customer or resource. Supports requestedUsage and requestedValues to evaluate against limits or enum values.
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.
Path parameters
The unique identifier of the entity
Query parameters
Feature ID (refId) to check. Mutually exclusive with currencyId.
Currency ID (refId) to check for credit entitlements. Mutually exclusive with featureId.
Resource ID to scope the entitlement check to a specific resource
Requested usage amount to evaluate against the entitlement limit (numeric features only)
Requested values to evaluate against allowed values (enum features only)
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
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 (feature or credit) for the requested customer, including granted status and any access denied reason.