Skip to main content
GET
/
api
/
v1
/
addons
/
{addonId}
/
entitlements
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 entitlements = await client.v1.addons.entitlements.list('addonId');

console.log(entitlements.data);
{
  "data": [
    {
      "id": "sodalitas callide sumo allatus suppono tenuis amaritudo somniculosus infit bos candidus arma curia cogito creator agnitio usque tollo curto sumptus beneficium veritatis textus tantum decens cur vorago cohors teres conor tyrannus sollicito anser thesis cum",
      "type": "FEATURE",
      "description": "Extra API calls",
      "isGranted": true,
      "isCustom": false,
      "order": 0,
      "behavior": "Increment",
      "hiddenFromWidgets": [],
      "displayNameOverride": null,
      "createdAt": "2025-12-21T13:17:45.042Z",
      "updatedAt": "2026-01-27T13:24:40.158Z",
      "featureId": "feature-api-calls",
      "usageLimit": 1000,
      "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"
  }
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Path Parameters

addonId
string
required

The addon ID

Maximum string length: 255

Response

A list of addon entitlement objects.

Response list object

data
AddonPackageEntitlement · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results