Skip to main content
DELETE
/
api
/
v1
/
addons
/
{addonId}
/
entitlements
/
{id}
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 addonPackageEntitlement = await client.v1.addons.entitlements.delete('id', {
  addonId: 'addonId',
});

console.log(addonPackageEntitlement.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

​
addonId
string
required

The addon ID

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

The feature ID or custom currency ID of the entitlement

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

Response

The deleted addon entitlement object.

Response object

​
data
FeatureEntitlementResponse · object
required

Feature entitlement response