Entitlements

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.

get/api/v1/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)

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 (feature or credit) for the requested customer, including granted status and any access denied reason.

Changes

Changed in 9 of the 115 revisions of this API.3105

Jul 28, 2026913f273cc2f71See the full diff
- ●
  added the new ContractNotFound enum value to the response property for the response status
  response-property-enum-value-added
Jul 23, 2026b876edd1a4fc5See the full diff
- ●
  added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new InvalidCreditOverageBillingModel enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status
  response-property-enum-value-added
Jul 8, 202658bb216ff8ce1See the full diff
- ●
  added the new GovernanceNotEnabled enum value to the response property for the response status
  response-property-enum-value-added
Jun 8, 20263acd63d6c8612See the full diff
- ○
  added the new optional header request parameter X-ACCOUNT-ID
  new-optional-request-parameter
- ○
  added the new optional header request parameter X-ENVIRONMENT-ID
  new-optional-request-parameter
Jun 4, 20264fa87d66426d1See the full diff
- ●
  added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status
  response-property-enum-value-added
May 31, 20260dece860f6781See the full diff
- ●
  added the new DataExportIntegrationError enum value to the response property for the response status
  response-property-enum-value-added
May 28, 2026b181b166a2a51See the full diff
- ●
  added the new InvalidReceivedSignatureError enum value to the response property for the response status
  response-property-enum-value-added
May 13, 202646f8cdfc98333See the full diff
- ▲
  for the query request parameter currencyId, the minLength was increased from 0 to 1
  request-parameter-min-length-increased
- ▲
  for the query request parameter featureId, the minLength was increased from 0 to 1
  request-parameter-min-length-increased
- ▲
  for the query request parameter resourceId, the minLength was increased from 0 to 1
  request-parameter-min-length-increased
May 13, 202635fbd550dc283See the full diff
- ○
  for the query request parameter currencyId, the minLength was decreased from 1 to 0
  request-parameter-min-length-decreased
- ○
  for the query request parameter featureId, the minLength was decreased from 1 to 0
  request-parameter-min-length-decreased
- ○
  for the query request parameter resourceId, the minLength was decreased from 1 to 0
  request-parameter-min-length-decreased

Full history