Delete a subscription entitlement privilege

Remove a privilege from a subscription entitlement override

curl --request DELETE \
  --url https://api.getlago.com/api/v1/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code} \
  --header 'Authorization: Bearer <token>'

{
  "entitlement": {
    "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"
    }
  }
}

DELETE

subscriptions

{external_id}

entitlements

{feature_code}

privileges

{privilege_code}

Remove a privilege from a subscription entitlement override

curl --request DELETE \
  --url https://api.getlago.com/api/v1/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code} \
  --header 'Authorization: Bearer <token>'

{
  "entitlement": {
    "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

external_id

string

required

External ID of the existing subscription

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

feature_code

string

required

Code of the existing feature.

Example:

"seats"

privilege_code

string

required

Code of the privilege to remove from the subscription entitlement override.

Example:

"max_admins"

Response

Subscription entitlement with privilege override removed

entitlement

object

required

Show child attributes

entitlement.code

string

required

Unique code used to identify the feature. Max 255 characters.

Example:

"seats"

entitlement.name

string | null

required

Name of the feature. Max 255 characters.

Example:

"Number of seats"

entitlement.description

string | null

required

Description of the feature. Max 600 characters.

Example:

"Number of users of the account"

entitlement.privileges

object[]

required

Privileges associated with this feature. Each privilege shows the plan value and any subscription override.

Show child attributes

entitlement.privileges.code

string

required

Unique code for the privilege.

Example:

"max"

entitlement.privileges.name

string | null

required

Display name for the privilege.

Example:

"Maximum"

entitlement.privileges.value_type

enum<string>

required

Data type of the privilege value. Default: string

Available options:

integer,

boolean,

string,

select

Example:

"integer"

entitlement.privileges.config

object

required

Show child attributes

entitlement.privileges.config.select_options

string[]

Array of string, required only when value_type is select.

Example:

["google", "okta"]

entitlement.privileges.value

required

Applicable value this this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.

Example:

10

entitlement.privileges.plan_value

required

Value assigned to this privilege in the plan. Type depends on the privilege's value_type.

Example:

10

entitlement.privileges.override_value

required

Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set.

Example:

10

Example:

[
  {
    "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"] }
  }
]

entitlement.overrides

object

required

Example:

{ "max": 15, "provider": "okta" }

Delete a subscription entitlement List subscription entitlements

⌘I

API Reference

Authorizations

Path Parameters

Response