API Reference
- The feature object
- POSTCreate a feature
- PUTUpdate a feature
- DELDelete a feature
- DELDelete a feature privilege
- GETRetrieve a feature
- GETList all features
- The plan entitlement object
- POSTCreate plan entitlements
- PATCHUpdate plan entitlements
- DELDelete a plan entitlement
- DELDelete a plan entitlement privilege
- GETRetrieve a plan entitlement
- GETList plan entitlements
- The subscription entitlement object
- PATCHUpdate subscription entitlements
- DELDelete a subscription entitlement
- DELDelete a subscription entitlement privilege
- GETList subscription entitlements
curl --request GET \
--url https://api.getlago.com/api/v1/subscriptions/{external_id}/entitlements \
--header 'Authorization: Bearer <token>'{
"entitlements": [
{
"code": "seats",
"name": "Number of seats",
"description": "Number of users of the account",
"privileges": [
{
"code": "max",
"name": "Maximum",
"value_type": "integer",
"config": {},
"value": 15,
"plan_value": 10,
"override_value": 15
},
{
"code": "max_admins",
"name": "Max Admins",
"value_type": "integer",
"config": {},
"value": 5,
"plan_value": 5,
"override_value": null
},
{
"code": "root",
"name": "Allow root user",
"value_type": "boolean",
"config": {},
"value": true,
"plan_value": true,
"override_value": null
},
{
"code": "provider",
"name": "SSO Provider",
"value_type": "select",
"value": "okta",
"plan_value": "google",
"override_value": "okta",
"config": {
"select_options": [
"google",
"okta"
]
}
}
],
"overrides": {
"max": 15,
"provider": "okta"
}
}
]
}List subscription entitlements
This endpoint retrieves all entitlements for a specific subscription, including both plan entitlements and any subscription-specific overrides.
curl --request GET \
--url https://api.getlago.com/api/v1/subscriptions/{external_id}/entitlements \
--header 'Authorization: Bearer <token>'{
"entitlements": [
{
"code": "seats",
"name": "Number of seats",
"description": "Number of users of the account",
"privileges": [
{
"code": "max",
"name": "Maximum",
"value_type": "integer",
"config": {},
"value": 15,
"plan_value": 10,
"override_value": 15
},
{
"code": "max_admins",
"name": "Max Admins",
"value_type": "integer",
"config": {},
"value": 5,
"plan_value": 5,
"override_value": null
},
{
"code": "root",
"name": "Allow root user",
"value_type": "boolean",
"config": {},
"value": true,
"plan_value": true,
"override_value": null
},
{
"code": "provider",
"name": "SSO Provider",
"value_type": "select",
"value": "okta",
"plan_value": "google",
"override_value": "okta",
"config": {
"select_options": [
"google",
"okta"
]
}
}
],
"overrides": {
"max": 15,
"provider": "okta"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
External ID of the existing subscription
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Response
List of subscription entitlements
Show child attributes
Show child attributes
Unique code used to identify the feature. Max 255 characters.
"seats"
Name of the feature. Max 255 characters.
"Number of seats"
Description of the feature. Max 600 characters.
"Number of users of the account"
Privileges associated with this feature. Each privilege shows the plan value and any subscription override.
Show child attributes
Show child attributes
Unique code for the privilege.
"max"
Display name for the privilege.
"Maximum"
Data type of the privilege value. Default: string
integer, boolean, string, select "integer"
Applicable value this this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.
10
Value assigned to this privilege in the plan. Type depends on the privilege's value_type.
10
Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set.
10
[
{
"code": "max",
"name": "Maximum",
"value_type": "integer",
"config": {},
"value": 15,
"plan_value": 10,
"override_value": 15
},
{
"code": "max_admins",
"name": "Max Admins",
"value_type": "integer",
"config": {},
"value": 5,
"plan_value": 5,
"override_value": null
},
{
"code": "root",
"name": "Allow root user",
"value_type": "boolean",
"config": {},
"value": true,
"plan_value": true,
"override_value": null
},
{
"code": "provider",
"name": "SSO Provider",
"value_type": "select",
"value": "okta",
"plan_value": "google",
"override_value": "okta",
"config": { "select_options": ["google", "okta"] }
}
]{ "max": 15, "provider": "okta" }