Introducing the Chargebee CLI

Feature Management

Plans, addons, and charges can unlock features. Subscriptions unlock features by virtue of the included plans, addons, and charges. Subscriptions can also unlock additional features via overrides.

The main actions you can perform on a feature are create, update, activate, archive, and delete.

You manage both metered and non-metered features from Entitlements > Features. The following sections explain each operation and note where metered features work differently. For the full details on metered features, see Managing Metered Features.

Use bulk operations to import multiple Features together in Chargebee.

Creating Features

Before you create a feature, decide whether it's metered or non-metered:

  • Metered feature: Chargebee meters usage of the feature from the usage events you send, applies the included usage from each plan and non-metered addon, and charges for overage when the subscription has a metered addon for the feature. Create metered features from Entitlements > Features > Create Feature by selecting Metered feature, or from Usages > Metered Features > Create Metered Feature. See Creating a Metered Feature.
  • Non-metered feature: Chargebee stores the entitlements, and your application grants access and tracks usage. Non-metered entitlements don't affect invoices. Create non-metered features from Entitlements > Features > Create Feature with the steps in this section.

For help choosing, see Metered and non-metered features in Chargebee.

To create a non-metered feature in the Chargebee user interface, follow these steps:

  1. Click Entitlements > Features > Create Feature, and under What kind of feature do you want to create?, select Non-metered feature.
  2. Under Feature info, enter the Internal name and Description of the feature. We recommend using the same name that you use to market the feature to your customers.
  3. If you leave Feature ID blank, a slug for the feature name is auto-generated. You can enter a new feature ID only on the Create feature page. Remember, once set, the ID cannot be changed.

Feature ID once created cannot be changed and is directly used in the API calls with Chargebee. If you intend to have a different Feature ID, it is strongly recommended that you use a particular format that is consistent and scalable for all your features.

Example: The company Acme is defining Features for their CRM product line, a good norm would be to use prefixes in the ID naming like acme-crm-feature-a.

The Feature Definitions section is where you can define the feature entitlement type and entitlement levels.

  • For switch-type features, select Switch as the Type.
  • For Quantity-type features, select Quantity as the Type and create the entitlement levels.
  • For Range-type features, select Range as the Type. Range allows you to create many entitlement levels within a range of values. Here you can only set a Default (Minimum) and Maximum value constraint. While assigning features to items, you have the flexibility to choose any value within the range provided.
  • For Custom-type features, select Custom as the Type and create the entitlement levels.

Viewing Features

When a feature is created successfully, it is listed on the Features index page. To navigate to the features index page, click Entitlements from the left navigation menu.

You can filter, search and navigate to the respective feature details pages from here.

By default, the name, status, type, and description of a feature are displayed for easy identification. You can also filter features using name, Id, status, and type.

The index page lists both metered and non-metered features. For a metered feature, the type is Metered, and selecting the feature opens its metered feature details page.

Details page

To navigate to the Features details page, click Entitlements > Select a feature.

The details page has all the information about whether the feature is activated or archived, the entitlements that have been added, along with the option to make changes to entitlements and the feature itself.

Each action inside the details page is elaborated further in the following sections.

Viewing Entitlements in Items

The details page of each product catalog item lists all the features attached to it. This keeps you informed about the Features in consideration when an item configuration needs to be changed.

If an item does not contain any feature entitlements, you are given the option to add new entitlements using Add Features.

Activating Features

When you create a non-metered feature, it starts in the Draft state. Metered features are active by default when you create them, so only non-metered features need activating.

A feature in the Draft state represents a feature in your product that you're still developing or still deciding how to take to market. You can make changes to this feature and its entitlements without affecting your customer entitlements until you activate it.

Activating a feature brings all its entitlements into effect so that eligible customers' entitlement lists will now include this feature.

Ensure that you assign the feature to applicable product catalog items using the Managing Product Entitlements option before activating a feature. Learn more.

To activate a feature, click Entitlements > Select feature > Activate Feature.

Updating Features

You can modify the details for existing features. Depending on the type of feature, Chargebee permits or disallows certain modifications based on whether entitlements have been defined for the feature or not.

For a metered feature, you can edit the name at any time and the unit until the feature is linked to an active subscription. You can change the aggregation method and filter conditions only until usage events are ingested or a usage alert is set on the feature. See Editing a Metered Feature.

To update a non-metered feature, follow these steps:

  1. Click Entitlements > Features.

  2. Select a feature from the Feature List page > Edit Feature.

  3. The Edit feature page has two sections: Feature info and Feature Definitions.

  4. In the Feature info section, update the Internal name and Description of the feature.

  5. In the Feature Definitions section, update the Entitlement Unit and the Display Name of the allowed entitlement.

  6. After making the changes to a feature, click Update to save your changes.

When updating a feature remember the following:

  • You can update the value of an entitlement only if it is not mapped to any Item or subscription entitlements.

  • You can add entitlement levels only to features of type Quantity and Custom.

  • You can remove an entitlement level only if it is not mapped to an Item or subscription entitlements.

  • Once a feature is created, you cannot change its entitlement type.

Archiving Features

If you intend to discontinue a feature, then archive it in Chargebee to make sure it is hidden from future prospects.

When a feature is archived,

  • Existing entitlements already granted to items and subscriptions cannot be edited, only removed.
  • New entitlements cannot be added to items and subscriptions.
  • Existing subscriptions with the feature would see no change.

An archived feature can be re-activated or deleted.

For what happens when you archive a metered feature, see Archiving a Metered Feature.

To archive a feature, click Entitlements > Select an active feature > Archive Feature.

Deleting Features

You can delete a feature that you might have misconfigured or one that is reaching end of life. This removes all related entitlements on catalog items and subscriptions.

You can delete a non-metered feature only when it's in the Draft or Archived state. You can delete a metered feature after you archive it, when it isn't linked to an active subscription and has no usage alert. See Deleting a Metered Feature.

Any entitlement configuration made for the feature is also deleted and cannot be recovered. The feature is also removed from any existing subscription it is part of.

To delete a feature, click Entitlements > Select a feature > Delete Feature.

Activity Log

Activity log tracks all the changes and events related to a feature. It displays the actual event or change, timestamp, along with the identity of who made that change or triggered that event.

Activity log is useful in debugging issues, as it allows you to view the history of events and changes associated with a feature.

Transfer Configurations

You can seamlessly transfer your configurations from one Chargebee site to another using Chargebee's Transfer Configurations. To use this feature, you need at least one Chargebee LIVE account.

What is transferredWhat is not transferred
Features in Active or Draft statusSubscription entitlements
Item entitlements of the featuresEntitlement overrides

By default, you can only transfer 250 features using Transfer Configurations.

FAQ

1) Can I assign entitlements to a feature in the Draft state? Yes, you can assign entitlements to a feature in the draft state at the items and subscription level. However, they only come into effect at the subscription level after activation.

2) How many features can I create on my site? The maximum number of features you can create on your site is 400.

See also

Features API