Skip to main content
POST
Create entitlement

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Entitlement configuration

feature_id
string
required
feature_type
enum<string>
required
Available options:
metered,
boolean,
static,
config
config_value
object
end_date
string<date-time>
entity_id
string
entity_type
enum<string>
Available options:
PLAN,
SUBSCRIPTION,
ADDON
is_enabled
boolean
is_soft_limit
boolean
parent_entitlement_id
string
plan_id
string
start_date
string<date-time>
static_value
string
usage_limit
integer
usage_reset_period
enum<string>
Available options:
MONTHLY,
ANNUAL,
WEEKLY,
DAILY,
QUARTERLY,
HALF_YEARLY,
NEVER

Response

Created

addon
object
config_value
object
created_at
string<date-time>
created_by
string
display_order
integer
end_date
string<date-time>
entity_id
string
entity_type
enum<string>
Available options:
PLAN,
SUBSCRIPTION,
ADDON
environment_id
string
feature
object
feature_id
string
feature_type
enum<string>
Available options:
metered,
boolean,
static,
config
id
string
is_enabled
boolean
is_soft_limit
boolean
parent_entitlement_id
string
plan
object
plan_id
string

TODO: Remove this once we have a proper entitlement entity type

start_date
string<date-time>
static_value
string
status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
updated_at
string<date-time>
updated_by
string
usage_limit
integer
usage_reset_period
enum<string>
Available options:
MONTHLY,
ANNUAL,
WEEKLY,
DAILY,
QUARTERLY,
HALF_YEARLY,
NEVER