Skip to main content
POST
/
api
/
v1
/
customers
/
{id}
/
promotional-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 promotionalEntitlement = await client.v1.customers.promotionalEntitlements.create('x', {
  promotionalEntitlements: [
    {
      customEndDate: '2019-12-27T18:11:19.117Z',
      enumValues: ['string'],
      featureId: 'featureId',
      hasSoftLimit: true,
      hasUnlimitedUsage: true,
      isVisible: true,
      monthlyResetPeriodConfiguration: { accordingTo: 'SubscriptionStart' },
      period: '1 week',
      resetPeriod: 'YEAR',
      usageLimit: -9007199254740991,
      weeklyResetPeriodConfiguration: { accordingTo: 'SubscriptionStart' },
      yearlyResetPeriodConfiguration: { accordingTo: 'SubscriptionStart' },
    },
  ],
});

console.log(promotionalEntitlement.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,
      "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-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

​
id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Grant promotional entitlements to a customer for a specified period.

​
promotionalEntitlements
GrantPromotionalEntitlementRequest · object[]
required

Promotional entitlements to grant

Minimum array length: 1

Response

The granted promotional entitlement objects.

Response object

​
data
PromotionalEntitlement · object[]
required