import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const planEntitlement = await client.v1.plans.entitlements.delete('id', { planId: 'planId' });
console.log(planEntitlement.data);{
"data": {
"id": "<string>",
"type": "FEATURE",
"description": "<string>",
"isGranted": true,
"isCustom": true,
"order": 123,
"behavior": "Increment",
"hiddenFromWidgets": [
"PAYWALL"
],
"displayNameOverride": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"featureId": "<string>",
"usageLimit": 123,
"hasUnlimitedUsage": true,
"hasSoftLimit": true,
"resetPeriod": "YEAR",
"resetPeriodConfiguration": {
"accordingTo": "SubscriptionStart"
},
"enumValues": [
"<string>"
],
"customCurrencyId": "<string>",
"amount": 123,
"cadence": "MONTH"
}
}Deletes an entitlement from a draft 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 planEntitlement = await client.v1.plans.entitlements.delete('id', { planId: 'planId' });
console.log(planEntitlement.data);{
"data": {
"id": "<string>",
"type": "FEATURE",
"description": "<string>",
"isGranted": true,
"isCustom": true,
"order": 123,
"behavior": "Increment",
"hiddenFromWidgets": [
"PAYWALL"
],
"displayNameOverride": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"featureId": "<string>",
"usageLimit": 123,
"hasUnlimitedUsage": true,
"hasSoftLimit": true,
"resetPeriod": "YEAR",
"resetPeriodConfiguration": {
"accordingTo": "SubscriptionStart"
},
"enumValues": [
"<string>"
],
"customCurrencyId": "<string>",
"amount": 123,
"cadence": "MONTH"
}
}Server API Key
Server API Key
The plan ID
255The feature ID or custom currency ID of the entitlement
255The deleted plan entitlement object.
Response object
Feature or credit entitlement on a plan
Show child attributes