Skip to main content
POST
/
api
/
v1
/
plans
/
{planId}
/
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 entitlement = await client.v1.plans.entitlements.create('planId', {
  entitlements: [{ id: 'id', type: 'FEATURE' }],
});

console.log(entitlement.data);
{
  "data": [
    {
      "id": "<string>",
      "description": "<string>",
      "isGranted": true,
      "isCustom": true,
      "order": 123,
      "hiddenFromWidgets": [],
      "displayNameOverride": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "type": "FEATURE",
      "usageLimit": 123,
      "hasUnlimitedUsage": true,
      "hasSoftLimit": true,
      "resetPeriodConfiguration": {
        "accordingTo": "SubscriptionStart"
      },
      "enumValues": [
        "<string>"
      ]
    }
  ]
}

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

​
planId
string
required

The plan ID

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Body

application/json

Request to create one or more entitlements on a plan

​
entitlements
(CreateFeatureEntitlementRequest · object | CreateCreditEntitlementRequest · object)[]
required

Entitlements to create

Minimum array length: 1

Request to create a feature entitlement

Response

The newly created plan entitlement objects.

Response object

​
data
(FeatureEntitlementResponse · object | CreditEntitlementResponse · object)[]
required

Feature entitlement response