Applicable Addons

Introduction

For any plan in Chargebee, you can choose what addons are applicable to its subscriptions. For example, if you are a SaaS company with say, plans named Grow, Hustle and Scale on offer, you may want some premium addons to be available only for the Hustle and Scale plans:

Once you have configured the addon applicability as above, when you select a plan during subscription creation/update, the applicable addons would then show up as below:

1. The Web Interface

When you choose a plan while creating a subscription in the web interface, Chargebee automatically attaches the applicable addons.

2. Chargebee Checkout

The following is a sample summary for the Scale plan. The addons are attached automatically, and their prices are shown.

3. Self-Serve Portal

This example shows a customer upgrading to the Scale plan using the Self-Serve Portal. Chargebee automatically attaches the applicable addons.

Configuration

To configure addon applicability:

1. Navigate to the details page of a plan.
2. Scroll to the section titled Addons.
3. Choose the settings you want.

You can allow all addons to be applicable to the plan, or click Manage to restrict them to a few or none.

Recurring and non-recurring addons are treated distinctly while associating them to plans in Chargebee.

Recurring Addons

When associating a recurring addon with a plan, you may choose one of the following options:

Mandatory

• When set as mandatory, the addon is automatically attached to new plan-activations and cannot be removed (except via API). The quantity cannot be edited either.
• If a subscription changes to another plan with which the addon is not mandatory, the addon is removed from it.

Recommended

When you set an addon as recommended in the Chargebee app, the addon is suggested in the Checkout and Portal to the customer. Provided you have enabled the and .

Note: Recommended addons are only available through the In-app Checkout and Self-serve portal.

In APIs, the attachment type attribute for the addon in the plan resource is set to recommended. You can then use this information to implement addon recommendations on your custom-built website/app.

Optional (Only available when addons are restricted)

Designating an addon as optional allows it to be attached to the subscription.

Note: Once an addon is attached to a plan as recommended or optional, it can then be added to any of its pre-existing subscriptions via the change subscription action.

Non-recurring Addons

There are two ways in which a non-recurring addon can be attached to a plan:

On Demand

This option makes the charge applicable for the plan, allowing you to manually attach it to subscriptions that include the plan. Note that the charge is not automatically attached to subscriptions with the plan. You must attach the charge either through the UI, or by passing it as a parameter when, for example, creating a subscription or creating a checkout for a subscription.

Event-based Application A non-recurring addon can be set to automatically attach to the subscription once or each time a certain event occur(s).

Note: For gift plans, you can only associate non-recurring addons on-demand. Event-based applications are not possible. The add addon action at the customer level can be used to add any non-recurring addon regardless of how addon applicability is configured.

The following is the list of events that can be chosen from:

• Subscription creation: Whenever a new subscription is created in Chargebee. Note that if a subscription is created today and set to start in the future, the subscription creation event is said to have happened today.

• Subscription trial start: For plans with trials, the time when the trial starts.

  Example: If you wish to charge your customers a fee for the trial period, you can create a non-recurring addon for it and set it for a plan to be charged on subscription trial start.

• Subscription activation: Whenever the subscription status goes active. This includes reactivations.

  Note: Choose the Apply charges option as Every time this event occurs if you wish to include the addon during subscription reactivations.

• Plan activation: This includes all cases under subscription activation and the case when the subscription undergoes a plan change.

  Note: Assume a plan XYZ with a non-recurring addon Activation fee attached to it, set to be charged on plan activation. If the plan of a subscription is changed from any other to XYZ, this addon would be immediately applied to the subscription. Now, if the plan is again changed to something else and then switched back to XYZ, the addon is only applied if the Apply charges option for it is set to Every time this event occurs in the details page for XYZ.

View Addon Association

Plan and addon association can be viewed at two places in Chargebee.

Plan Details Page

All the applicable addons for a particular plan can be seen on the details page of the plan.

Addon Details Page

Similarly, the details page for an addon shows the plans that it is associated with.