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": "corrumpo laboriosam consectetur patrocinor tum concedo vero acidus quam impedit attero tum cibo apparatus aperte vetus conatus argentum vorago spoliatio absorbeo dens bonus inflammatio ad ipsam cito tracto denuo carus ter maiores thema sperno tandem iste ",
"type": "FEATURE",
"description": "Access to advanced analytics",
"isGranted": true,
"isCustom": false,
"order": 0,
"behavior": "Increment",
"hiddenFromWidgets": [],
"displayNameOverride": null,
"createdAt": "2025-05-15T21:43:30.550Z",
"updatedAt": "2027-02-19T12:51:41.703Z",
"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": "corrumpo laboriosam consectetur patrocinor tum concedo vero acidus quam impedit attero tum cibo apparatus aperte vetus conatus argentum vorago spoliatio absorbeo dens bonus inflammatio ad ipsam cito tracto denuo carus ter maiores thema sperno tandem iste ",
"type": "FEATURE",
"description": "Access to advanced analytics",
"isGranted": true,
"isCustom": false,
"order": 0,
"behavior": "Increment",
"hiddenFromWidgets": [],
"displayNameOverride": null,
"createdAt": "2025-05-15T21:43:30.550Z",
"updatedAt": "2027-02-19T12:51:41.703Z",
"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
The plan ID
255