v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB

Entitlements

Create entitlement

Use when attaching a feature (and its limit) to a plan or addon (e.g. "10 seats" or "1000 API calls"). Defines what the plan/addon includes.

post/entitlements

Request body

aggregation_mode'additive' | 'parallel'

config_valueobject

end_datestring date-time

entity_idstring

entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON'

feature_idstring required

feature_type'metered' | 'boolean' | 'static' | 'config' required

grant_duration_unit'hour' | 'day' | 'week'

grant_duration_valueinteger

grant_measure'quantity' | 'amount'

grant_quotastring

is_enabledboolean

is_soft_limitboolean

parent_entitlement_idstring

plan_idstring

start_datestring date-time

static_valuestring

usage_limitinteger

Response

Created

aggregation_mode'additive' | 'parallel'

config_valueobject

created_atstring date-time

created_bystring

display_orderinteger

end_datestring date-time

entity_idstring

entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON'

environment_idstring

feature_idstring

feature_type'metered' | 'boolean' | 'static' | 'config'

grant_duration_unit'hour' | 'day' | 'week'

grant_duration_valueinteger

grant_measure'quantity' | 'amount'

grant_quotanumber

idstring

is_enabledboolean

is_soft_limitboolean

parent_entitlement_idstring

plan_idstring

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

start_datestring date-time

static_valuestring

status'published' | 'deleted' | 'archived'

tenant_idstring

updated_atstring date-time

updated_bystring

usage_limitinteger