Addons are additional charges applied to a subscription apart from the base plan charge. The addons can be recurring or non-recurring. A recurring addon included in a subscription is charged as per billing frequency of subscription. A non-recurring addon included in subscription will be charged immediately and only once. And a non-recurring addon is NOT pro-rated based on billing cycle, whereas a recurring addon is automatically pro-rated based on billing cycle.
optional, string, max chars=500 Description about the addon to show in the hosted pages & customer portal. This description will not be shown if multiple addons are added.
enumerated string Select "On-Off" to charge a flat fee or "Quantity" for unit based charges.
Possible values are
on_offAddon that does not have any quantity associated and can only be enabled or disabled. Example: On call support at $99 per month.quantityCharges this price for every unit of the addon. Example: 2 additional support agents at $10 each
enumerated string, default=recurring Type of charge
Possible values are
recurringCharges are automatically applied in sync with the billing frequency of subscription.non_recurringCharged immediately and only once every time it is applied.
optional, string, max chars=30 Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent. Applicable only for quantity type addons.
enumerated string, default=active Status of the addon
Possible values are
activeOnly active addons can be applied to subscriptionsarchivedNo new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.deletedIndicates the addon has been deleted.
optional, string, max chars=2000 A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
optional, string, max chars=500 Description about the addon to show in the hosted pages & customer portal. This description will not be shown if multiple addons are added.
optional, string, max chars=30 Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent. Applicable only for quantity type addons.
optional, string, max chars=2000 A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
optional, string, max chars=500 Description about the addon to show in the hosted pages & customer portal. This description will not be shown if multiple addons are added.
required, enumerated string, default=recurring Type of charge.
Possible values are
recurringCharges are automatically applied in sync with the billing frequency of subscription.non_recurringCharged immediately and only once every time it is applied.
optional, enumerated string Select "On-Off" to charge a flat fee or "Quantity" for unit based charges.
Possible values are
on_offAddon that does not have any quantity associated and can only be enabled or disabled. Example: On call support at $99 per month.quantityCharges this price for every unit of the addon. Example: 2 additional support agents at $10 each
optional, string, max chars=30 Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent. Applicable only for quantity type addons.
optional, string, max chars=2000 A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
optional, string, max chars=500 Description about the addon to show in the hosted pages & customer portal. This description will not be shown if multiple addons are added.
optional, enumerated string, default=recurring Type of charge.
Possible values are
recurringCharges are automatically applied in sync with the billing frequency of subscription.non_recurringCharged immediately and only once every time it is applied.
optional, enumerated string Select "On-Off" to charge a flat fee or "Quantity" for unit based charges.
Possible values are
on_offAddon that does not have any quantity associated and can only be enabled or disabled. Example: On call support at $99 per month.quantityCharges this price for every unit of the addon. Example: 2 additional support agents at $10 each
optional, string, max chars=30 Specifies the type of quantity. For example, if the addon price is $10 and 'agent' is the unit of measure, the addon will be $10/agent. Applicable only for quantity type addons.
optional, string, max chars=2000 A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
optional, string, max chars=1000 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.
always returned optional, string, max chars=1000 This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
When an addon that already has subscriptions/invoices linked to it is deleted, it does not get completely purged but is instead moved to "Archived" state. No other subscriptions can use this addon but subscriptions already on it will continue to renew. Once an addon has been archived, it cannot be edited or used again and the addon cannot be un-archived.
If no subscriptions or invoices are linked to an addon, the addon will be permanently deleted from your Chargebee site. This action cannot be undone.
If an addon that is an applicable item for a coupon is deleted, then the addon will be removed from that coupon's list of applicable items.
Archiving an addon will not affect coupons in anyway.
This API is not enabled for live sites by default. Please contact
support to get this enabled.
Notes
Sample Request
curl https://{site}.chargebee.com/api/v1/addons/test/delete \
-X POST \
-u {site_api_key}: