Update feature status
Replaces the Feature resource.
Authorizations
Value for the Authorization header parameter.
Path Parameters
Feature identifier
Body
Update the status of a entitlement feature.
The new status of the feature.
draft
, active
, archived
Only for status change to "active". Whether the entitlements of this feature should be applied to existing subscriptions using this product or price.
Response
Get all entitlement features.
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.
The name of the feature. Examples: number of users
, disk usage
, traffic
, CRM integration
, API access
.
The description of the feature, shown in the admin-UI.
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.
draft
, active
, archived
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.
switch
, custom
, quantity
, range
The config of the feature. This is only required for the types custom
, quantity
and range
.
Was this page helpful?