Skip to content

Create entitlement

POST
/v1/entitlements/

Create an entitlement linking a feature to a plan with a value.

EntitlementCreate
object
plan_id
required
Plan Id
string format: uuid
feature_id
required
Feature Id
string format: uuid
value
required
Value
string
>= 1 characters

Successful Response

EntitlementResponse
object
id
required
Id
string format: uuid
plan_id
required
Plan Id
string format: uuid
feature_id
required
Feature Id
string format: uuid
value
required
Value
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Invalid plan or feature reference

Unauthorized – invalid or missing API key

Entitlement for this plan/feature already exists

Validation error