PUT
/
entitlement
/
features
/
{id}
curl -X PUT \
 /entitlement/features/{id} \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "name": "number of users",
    "description": "This feature allows you to manage the number of users in your account.",
    "config": [
        ""
    ],
    "unit": "a8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
}'
{
  "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>",
  "productAssignmentsCount": 5,
  "productPriceAssignmentsCount": 3,
  "entitlementsCount": 15
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

Feature identifier

Body

The updated Feature resource

Update a entitlement feature.

​
name
string
required

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

Example:

"number of users"

​
config
string[]
required

The updated config of the feature. Required for the types custom, quantity and range.

Example:
[
  { "value": "5", "label": "5 users" },
  { "value": "10", "label": "10 users" },
  {
    "value": "unlimited",
    "label": "Unlimited users"
  }
]
​
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."

​
unit
string | null

The unit of the feature. This can be used to define the unit of the quantity. This is optional.

Example:

"a8b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"

Response

200
application/json
Feature resource updated

Get a entitlement 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"

​
name
string

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

Example:

"number of users"

​
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."

​
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"

​
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"

​
config

The config of the feature. This is only required for the types custom, quantity and range.

​
unit
string | null
​
productAssignmentsCount
integer

The number of product assignments.

Example:

5

​
productPriceAssignmentsCount
integer

The number of product price assignments.

Example:

3

​
entitlementsCount
integer

The number of entitlements.

Example:

15

Was this page helpful?

Create featureUpdate feature status