import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const entitlements = await client.v1.plans.entitlements.list('planId');
console.log(entitlements.data);{
"data": [
{
"id": "audax approbo odit sint avaritia desparatus desino crinis cruentus rem canto custodia aiunt vitae uxor nostrum defaeco trepide accendo traho speculum ab volo caries acervus cursim uter charisma cumque cursim accedo umquam eveniet sponte callide decens nem",
"type": "FEATURE",
"description": "Access to advanced analytics",
"isGranted": true,
"isCustom": false,
"order": 0,
"behavior": "Increment",
"hiddenFromWidgets": [],
"displayNameOverride": null,
"createdAt": "2025-03-22T01:18:17.707Z",
"updatedAt": "2026-07-17T18:35:04.212Z",
"featureId": "feature-advanced-analytics",
"usageLimit": 100,
"hasUnlimitedUsage": false,
"hasSoftLimit": false,
"resetPeriod": null,
"resetPeriodConfiguration": null,
"enumValues": null,
"customCurrencyId": null,
"amount": null,
"cadence": null
}
],
"pagination": {
"next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
"prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
}
}Retrieves a list of entitlements for a plan.
import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const entitlements = await client.v1.plans.entitlements.list('planId');
console.log(entitlements.data);{
"data": [
{
"id": "audax approbo odit sint avaritia desparatus desino crinis cruentus rem canto custodia aiunt vitae uxor nostrum defaeco trepide accendo traho speculum ab volo caries acervus cursim uter charisma cumque cursim accedo umquam eveniet sponte callide decens nem",
"type": "FEATURE",
"description": "Access to advanced analytics",
"isGranted": true,
"isCustom": false,
"order": 0,
"behavior": "Increment",
"hiddenFromWidgets": [],
"displayNameOverride": null,
"createdAt": "2025-03-22T01:18:17.707Z",
"updatedAt": "2026-07-17T18:35:04.212Z",
"featureId": "feature-advanced-analytics",
"usageLimit": 100,
"hasUnlimitedUsage": false,
"hasSoftLimit": false,
"resetPeriod": null,
"resetPeriodConfiguration": null,
"enumValues": null,
"customCurrencyId": null,
"amount": null,
"cadence": null
}
],
"pagination": {
"next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
"prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
}
}Server API Key
Server API Key
The plan ID
255