Update entitlement status

cURL

curl -X PUT \
 /entitlements/{id}/status \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "active": ""
}'

{
  "id": "<string>",
  "subscriptionItem": {
    "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
    "name": "Fitness M",
    "description": "Everything included",
    "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
    "status": "active",
    "subscriptionId": "<string>"
  },
  "feature": {
    "id": "feature-1",
    "name": "number of users",
    "description": "This feature allows you to manage the number of users in your account.",
    "status": "active",
    "type": "switch",
    "config": [
      {
        "value": "<string>",
        "label": "<string>"
      }
    ],
    "unit": "<string>"
  },
  "value": "true",
  "validFrom": "2023-11-07T05:31:56Z",
  "validUntil": "2023-11-07T05:31:56Z",
  "active": true
}

PUT

entitlements

{id}

status

cURL

curl -X PUT \
 /entitlements/{id}/status \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "active": ""
}'

{
  "id": "<string>",
  "subscriptionItem": {
    "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
    "name": "Fitness M",
    "description": "Everything included",
    "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
    "status": "active",
    "subscriptionId": "<string>"
  },
  "feature": {
    "id": "feature-1",
    "name": "number of users",
    "description": "This feature allows you to manage the number of users in your account.",
    "status": "active",
    "type": "switch",
    "config": [
      {
        "value": "<string>",
        "label": "<string>"
      }
    ],
    "unit": "<string>"
  },
  "value": "true",
  "validFrom": "2023-11-07T05:31:56Z",
  "validUntil": "2023-11-07T05:31:56Z",
  "active": true
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

Entitlement identifier

Body

The updated Entitlement resource

active

boolean

The status of the entitlement

Response

Entitlement resource updated

Get all entitlements of a subscription

string

subscriptionItem

object

Show child attributes

subscriptionItem.id

string

Example:

"01F9ZQZJZJQZJZJZJZJZJZJZJZ"

subscriptionItem.name

string

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

Example:

"Fitness M"

subscriptionItem.description

string | null

The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

Example:

"Everything included"

subscriptionItem.furtherInformation

string | null

Further information defines additional information for the item which will be displayed in the invoice.

Example:

"Additional agreements: The contract includes a free drink flatrate."

subscriptionItem.status

enum<string>

The status of the item.

Possible values:

active: The item is active and will be billed.
canceled: The item is canceled and will be billed until the end of the contract.
pending: The item is pending and will be billed after the contract start.
terminated: The item is terminated and will not be billed.

Available options:

active,

canceled,

pending,

terminated

Example:

"active"

subscriptionItem.subscriptionId

string

feature

object

Show child attributes

feature.id

string

The identifier of the feature, this can be a slug or a id. If not provided, it will be generated automatically. This must be unique.

Example:

"feature-1"

feature.name

string

The name of the feature. Examples: number of users, disk usage, traffic, CRM integration, API access.

Example:

"number of users"

feature.description

string | null

The description of the feature, shown in the admin-UI.

Example:

"This feature allows you to manage the number of users in your account."

feature.status

enum<string>

The status of the feature. Draft: The feature is not yet published. Those can be used to create entitlements but they won't be available until activation. Active: The feature is available and can be used. Archived: The feature is no longer available and can't be used for new entitlements. Existing entitlements will still work. Archived features can be activated again.

Available options:

draft,

active,

archived

Example:

"active"

feature.type

enum<string>

The type of the feature. switch: The feature can be enabled or disabled for a subscription. You can add additional config options in the options key. custom: The levels of the feature can be fully customized. As an example, you can define a feature SLA with 3 levels: basic, premium, enterprise. quantity: The levels of the feature are based on a quantity. As an example, you can define a feature number of users with levels 5, 10, 25, 50, 100. You can also provide a unlimited level. range: The value can be customized in a given range. As an example, you can define a feature disk usage with a range from 1GB to 1000GB, you can also provide a unlimited level to allow all values.

Available options:

switch,

custom,

quantity,

range

Example:

"switch"

feature.config

object

Custom, quantity · object[]
Range · object

Show child attributes

feature.config.value

required

feature.config.label

string

required

feature.unit

string | null

value

string

The value of the entitlement. Can be a boolean (switch), a string (custom), a number (quantity) or a custom number (range).

Example:

"true"

validFrom

string<date-time> | null

The date from which the entitlement is valid

validUntil

string<date-time> | null

The date until which the entitlement is valid

active

boolean

Get subscription item entitlements Delete entitlement

⌘I

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Update entitlement status

Authorizations

Path Parameters

Body

Response