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

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.customers.checkEntitlement('x');

console.log(response.data);

200

{
  "data": {
    "isGranted": true,
    "type": "FEATURE",
    "accessDeniedReason": null,
    "feature": {
      "id": "feature-api-calls",
      "displayName": "API Calls",
      "featureType": "NUMBER",
      "featureStatus": "ACTIVE"
    },
    "usageLimit": 10000,
    "hasUnlimitedUsage": false,
    "resetPeriod": "MONTH",
    "currentUsage": 2500
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

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-ID · string

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

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Query Parameters

featureId · string

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

Required string length: 1 - 255

currencyId · string

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

Required string length: 1 - 255

resourceId · string

Resource ID to scope the entitlement check to a specific resource

Required string length: 1 - 255

requestedUsage · integer

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

Required range: x >= 0

requestedValues · string[]

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

Response

200

application/json

The single entitlement (feature or credit) for the requested customer, including granted status and any access denied reason.

Response object

data · object · required

Option 1

Option 2

Show child attributes