Skip to main content
DELETE
/
api
/
v1
/
customers
/
{id}
/
promotional-entitlements
/
{featureId}
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 response = await client.v1.customers.promotionalEntitlements.revoke('featureId', {
  id: 'id',
});

console.log(response.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "featureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isVisible": true,
    "usageLimit": 123,
    "hasSoftLimit": true,
    "hasUnlimitedUsage": true,
    "status": "Active",
    "period": "1 week",
    "resetPeriod": "YEAR",
    "resetPeriodConfiguration": {
      "accordingTo": "SubscriptionStart"
    },
    "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enumValues": [
      "<string>"
    ],
    "featureGroupIds": [
      "<string>"
    ]
  }
}

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-API-KEY
string
required

API Key

Path Parameters

id
string
required

The unique identifier of the customer

Maximum string length: 255
featureId
string
required

The unique identifier of the entitlement feature

Maximum string length: 255

Response

The revoked promotional entitlement object.

Response object

data
PromotionalEntitlement · object
required

Granted feature entitlement