Introducing the Chargebee CLI

How do I set the billing cycle for a recurring add-on?

Problem Statement

You want to limit how long a recurring add-on stays attached to a subscription.

Solution

If you want an add-on to remain attached to the subscription for only a fixed number of billing cycles, set the add-on billing cycle parameter while creating or updating the subscription.

Set up a recurring add-on.

To add the add-on to a new subscription, navigate to Subscriptions and click Create New Subscription. Click Add Recurring Add-on. Here, you choose the add-on and enter the billing cycle.

The add-on is added to the invoice for the new subscription. As the term progresses and more invoices are generated for each billing cycle, the billing cycle decreases to zero and the add-on is removed afterward.

To add the add-on to an existing subscription, locate the subscription and click Edit Subscription.

Then click the edit icon for the add-on to change the number of billing cycles.

For existing subscriptions, when an add-on is added, a prorated invoice is generated based on the subscription term. The prorated period is treated as one billing cycle for the add-on. If you add a billing cycle to an existing add-on linked to a subscription, no charge is raised. However, the number of billing cycles for the add-on on the subscription increases by 1.

If the term of the subscription changes (for example, from monthly to quarterly) and the change is made through the API, ensure that the billing cycle of the add-on is also passed. If not, the add-on billing cycle resets to Forever, and the customer is charged for the add-on indefinitely.