ChargebeeAPI

Create a feature

Idempotency Supported
Try in API Explorer

Creates a new feature.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/features

Input Parameters

id
optional, string, max chars=50

A unique and immutable identifier for the feature. You can set it yourself, in which case it is recommended that a human-readable format (or slug) be used. For example, number-of-users-ccjht01. When not provided, a random value is automatically set.

name
required, string, max chars=50

A case-sensitive unique name for the feature. For example: user license , data storage , Salesforce Integration , devices , UHD Streaming , and so on.

Note: This name is not displayed on any customer-facing documents or pages such as invoice PDFs or hosted pages. However, in the future, it is likely to be introduced on the Self-Serve Portal .

description
optional, string, max chars=500

A brief description of the feature. For example: Access to 10TB cloud storage .

type
optional, enumerated string

The type of feature.

Possible Enum Values
switch

A switch or toggle is a feature that an item or subscription can be either fully entitled to or not entitled to at all.

custom

The entitlement levels available for this feature are defined as a set of custom values. For example, a feature Email Support can have entitlement levels as 24×7 and 24×5 .

quantity

The feature is quantity-based and entitlement levels available for it are a set of predefined number of quantity units. For example, a feature with name such as number of users can have entitlement levels of say, 5 , 20 , 50 , and 100. levels[is_unlimited] is used for specifying the "unlimited" entitlement level.

range

The feature is quantity-based and the entitlement levels available for it are the set of whole numbers within a range. The range is defined by a minimum and a maximum value. For example, a feature such as number of users can have entitlement levels starting at 5 users and go up to 50000. levels[is_unlimited] is used for specifying the "unlimited" entitlement level.

status
optional, enumerated string

The current status of the feature.

Possible Enum Values
active

A draft or an archived feature can be changed to active. Any entitlements or subscription entitlements defined for the feature take effect immediately.

draft

The feature is in an unpublished state. Entitlements and subscription entitlements can be created for a draft feature but they are not effective until the feature is active. A feature status cannot be changed back to draft once it is in active or archived status .

unit
optional, string, max chars=50

For features of type quantity or range , this specifies the unit of measure. The value is expected in the singular form and when used by the system, it is pluralized automatically as needed. For example, for a feature such as user licenses , the unit can be license .

levels
optional, string

Parameters for levels

Returns

featureFeature object

Resource object representing feature