Getting Started

Building Blocks

Custom Fields

Subscription Features




Billing Features


Payment Methods

Direct Debit Payments

Configuring Gateways

Revenue Recovery

Hosted Pages


Reports and Analytics

Data Privacy & Security

Fraud Management


Open Source Resources

Other Features

API Integration

Third Party Integrations


What can I do with an Addon? 

Addons are a great way of selling additional products/services to your customers and boost your sales revenue. Chargebee helps you do just that.

Addons can be including in a Subscription while:

  • Creating the Subscription
  • Changing/Updating the Subscription

If the addon is non-recurring, you can use the Add Addon option in the Subscription Details page

Naming your Addon 

Provide a unique name for the addon. A name that is short and also easy to understand what the addon is all about. This name will be displayed on the web interface and during sign ups.

Naming your addon "addon1", "addon 2" could be quite hard and time consuming to find out what it is for. Instead naming it like "Anti Virus software" or "E-mail Accounts" would make life a lot easier.

Just like plans, addon names cannot be reused unless the addon has been deleted and NOT archived.

What is the Id field used for? 

The Chargebee API uses the unique addon id and NOT the name to identify the addons that are on your website. The id is the unique identifier of the addon. When a subscription is created or updated via the API from your app/website, the "id" should be used to refer to the addon.

If you edit the addon ID, then the same changes need to be updated on the merchant application to ensure the API calls can identify the new ID.

Naming your addon for the invoices 

This is the display name of the addon line item on the invoice. For Example:

By default, the addon name you enter will be used as the invoice name, but if you want a different name to be shown on the invoice, you can specify it in the "Invoice Name" field.

What type of Addons can I use? 

On Off

On Off addons can be used for orders that do not have a quantity associated with them.


Along with the online storage if you sell "Premium Support", this would be an "On Off" addon. There is no quantity associated with it.


Quantity based addons can be used when buyers are purchasing products in units. If you choose the addon type as "Quantity", you need to mention the Quantity Units as well.


You can sell anti-virus software for devices as an addon.

Addon Type: Quantity

Quantity Unit: Device

Price: $10 / 1 Month(s)

This addon will be charged as $10/Device/Month

Charge Type and Pricing 

Chargebee offers 2 kinds of addons:

  1. Recurring Addon
  2. Non Recurring Addon

A recurring addon renews along with the plan's frequency. You can set the price frequency as either weekly, monthly or yearly and you can also set a value for the frequency. Setting the price frequency does not mean that the addon will be charged based on that interval. This frequency is only used to determine the price of the addon. Click here to see the compatibility of different addon frequencies with corresponding plan frequencies.


You can override the price of a recurring addon before you append it to a subscription. Navigate to the subscription details page (Subscriptions > [subscription ID]) to enter the new price of the addon.

So, if a plan is "Yearly" and the addon is priced per month, then the addon amount applied will be the addon price x 12 months.

Let us consider this scenario:

A customer has subscribed on a Yearly basis for online storage on 100 devices, and they decide that they would need 50 email accounts along with it. This can be added to the existing subscription as a recurring addon.

So this addon will be configured as:

Addon Charge Type: Recurring

Price: $10 / 1 Month(s)

Plan Frequency: Yearly

The addon charge for this subscription will be $120, because the plan interval is yearly (12 months) and the addon is monthly.

Similarly, if the plan is a quarterly plan, the addon charge will be $30 ($10 x 3 months).

A non-recurring (onetime) addon can be used for a single purchase along with a subscription. It is basically a non-recurring charge on a customer's subscription. These charges occur immediately and are not constrained to the subscription's renewal date.


A customer needs to backup a lot of data, and needs it done fast. If you offer the option of backing up directly from a physical storage device to your servers, you can use a non-recurring charge because the customer will only do when needed.

Let us take a look at a few examples of how different types of addons that can be created along with different plan types:

Example 1:

If the charge type is Recurring, the price value is $10 / per month, and the addon type is On Off, the addon can only be applied to plans that have a monthly billing frequency. The price you enter is applied every 12 months.


Charge Type: Recurring

Addon Price: $10 / 1 Month(s)

Addon Type: On Off

Plan Billing: Yearly

For this example, a $120 charge would be applied to the subscription. If the plan were a monthly plan, then $10 would be charged on each renewal along with the plan charges.

Example 2:

If the charge type is Recurring, price value is $1 / per month and the addon type is Quantity, then the addon amount that will be charged would be $1 x total quantity subscribed on a monthly basis.


Charge Type: Recurring

Addon Type: Quantity

Addon Price: $1 / 1 Month(s)

Subscribed Addon Quantity: 5

Plan Billing: Monthly

Total Addon Cost: $5/per month

For the example above, if the plan were a yearly plan, then the addon cost would be $60 ($5 x 12 months) which would be charged immediately for the entire year and the addon will be renewed along with the plan. If the addon is applied any time during the life-cycle of the subscription and not during sign up, then the addon charge will be automatically prorated and applied.

Example 3:

If the charge type is Non Recurring and the addon type is On Off, then the addon charge would be a onetime charge. The charge will not recur.


Addon Type: On Off

Charge Type: Non Recurring

Addon Price: $10

Plan Billing: Yearly

Total Addon Cost: $10

Here, even if the plan is a monthly plan, there would only be a onetime charge of $10 that will never renew.

Example 4:

If the addon type is Quantity and the charge type is Non Recurring, then the addon price would be calculated by multiplying the total quantity subscribed, and the charge would be made only when the addon is applied.

Cloning an addon 

Cloning an addon involves replicating an existing addon to make changes to it. You can also use this option to increase the addon price for new subscriptions while keeping your existing subscriptions on the old price. Alternatively, if you want existing subscriptions to be charged onto the new price, you can use the ‘Change Subscription' option.

*Changes related to the type of addon and the pricing of an addon can be done with the ‘Clone Addon' option.

Cloning an addon consists of the same steps involved in cloning a plan. Here's how to clone a plan .


Ensure that the old addon is archived after cloning so it does not appear in the customer portal.

Can I add a recurring Addon to a subscription after a period of time? 

Yes you can. When a buyer needs additional products added to their existing subscription, we can add a recurring addon. For Example:


An existing customer has a yearly online storage plan, and in the middle of the 6th month they decide they need email accounts. You can sell this product as a recurring addon to them.

Subscription Start Date: 1-Jan-2010

Plan Billing Frequency: Yearly

Addon Start Date: 1-Jun-2010

Addon Charge Type: Recurring

Addon Price: $10 / 1 Month(s)

The subscription will be charged $60 (prorated amount for the remaining 6 months of the subscription) for the addon and will continue to be renewed each year on the 1st of Jan as long as the subscription remains active. The first charge will be made as soon as the addon is applied (1-Jun-2010).

Can I add an Addon with any frequency to a plan with any frequency? 

Only addons with a specific frequency can be added to a corresponding subscription plan.

Weekly addons can only be added to weekly plans

Monthly addons can only be added to monthly / yearly plans

Yearly addons can only be added to yearly plans

What are the accounting fields for? 

The Accounting Information section helps Chargebee sync up with any accounting applications that you integrate with, like Xero and Quickbooks. Each of the accounting fields captures information that helps track product specific sales/revenue from an accounting perspective.

  • Accounting code: This field captures your Accounting systems' General Ledger Account code/name. When product information is synced to the Accounting system, the product specific information will be synced with this account as captured here. This is a mandatory field. You cannot proceed with accounting integration if this field is left blank.

  • Accounting category: The Accounting Category captures product specific additional metadata or categorization for reporting purpose in the accounting systems (such as regions you are selling to or branches you are selling from). It should be entered in the format: : (example: Region: North).

If you are using QuickBooks - you can enter one category (referred as Classes/sub-classes)

If you are using Xero - you can enter two categories, Accounting Category_1, Accounting Category_2 (referred as Tracking categories).

For information regarding these fields in API, refer the addons section in the API documentation .


These fields will not be available by default, you should enable these fields at Settings > Configure Chargebee > Billing Rules and select Enable Accounting Fields for integration.

Onetime charges vs. Non-Recurring Addons 

To an existing subscription, you can also add a onetime charge (using "Add Charge" in the subscription) instead of a non-recurring addon. The difference between the two is that the onetime charge would be an ad hoc charge; meaning it can be used for charging any product/service that has not yet been modeled into your billing system unlike your addon which has been pre-configured.

Note: If you do have a usage-based or metered billing subscription model, then you can create non recurring quantity based addons to apply metered charges as addons. Learn more about metered billing.

Editing and Deleting Addons 

Editing and deleting addons has the same exact behavior as plans. Please refer to Plans for more on this.

Was this article helpful?