GET /features

Retrieves a list of features meeting all the conditions specified in the filter parameters.

Servers

Request headers

Name Type Required Description
chargebee-request-origin-device String No

The device from which the customer has made the request

chargebee-business-entity-id String No

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

chargebee-request-origin-user String No

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-ip String No

The IP address of the customer where the request originated

chargebee-request-origin-user-encoded String No

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

Query parameters

Name Type Required Description
id Object No

optional, string filter
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.
Supported operators : is, is_not, starts_with, in, not_in

Example → id[is] = "fea-user-licenses"

limit Integer No

The number of resources to be returned.

Default value: 10

name Object No

optional, string filter
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.
Supported operators : is, is_not, starts_with, in, not_in

Example → name[is] = "User licenses"

type Object No

optional, enumerated string filter
The type of feature. Possible values are : switch, custom, quantity, range.
Supported operators : is, is_not, in, not_in

Example → type[is] = "boolean"

status Object No

optional, enumerated string filter
The current status of the feature. Possible values are : active, archived, draft.
Supported operators : is, is_not, in, not_in

Example → status[is] = "active"

offset String No

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.