Skip to main content
POST
JavaScript

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