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.
Documentation Index
Fetch the complete documentation index at: https://docs.stigg.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Server API Key
Path Parameters
The unique identifier of the entity
1 - 255Query Parameters
Feature ID (refId) to check. Mutually exclusive with currencyId.
1 - 255Currency ID (refId) to check for credit entitlements. Mutually exclusive with featureId.
1 - 255Resource ID to scope the entitlement check to a specific resource
1 - 255Requested usage amount to evaluate against the entitlement limit (numeric features only)
x >= 0Requested values to evaluate against allowed values (enum features only)
Response
The single entitlement (feature or credit) for the requested customer, including granted status and any access denied reason.
Response object
- Option 1
- Option 2
