Create a new addon.
Sample Request
URL Format
Input Parameters
The display name used in web interface for identifying the addon.
Display name used in invoice. If it is not configured then name is used in invoice.
Description about the addon to show in the hosted pages & customer portal. This description will not be shown if multiple addons are added. Note:
If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
Type of charge.
Charges are automatically applied in sync with the billing frequency of subscription.
Charged immediately and only once every time it is applied.
Addon price is calculated based on the addon type and charge type. Learn more. The unit depends on the type of currency .
The currency code (ISO 4217 format) of the addon.
Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon.
Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon.
Charge based on Day(S)
Charge based on week(s)
Charge based on month(s)
Charge based on year(s)
not applicable for this addon
Defines how the charges for the addons are calculated.
A fixed price that is not quantity-based.
A fixed price per unit quantity.
There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
The per unit price is based on the tier that the total quantity falls in.
A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
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.
If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal.
Specifies whether taxes apply to this addon. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
Indicates the type of sale carried out. This is applicable only if you use Chargebee's AvaTax for Communications integration.
Transaction is a sale to another company that will resell your product or service to another consumer
Transaction is a sale to an end user
Transaction is for an item that is consumed directly
Transaction is for an item that is subject to vendor use tax
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee's AvaTax for Communications integration.
Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee's AvaTax for Communications integration.
The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's AvaTax for Sales integration .
The HSN code to which the item is mapped for calculating the customer's tax in India. Applicable only when both of the following conditions are true:
- India has been enabled as a Tax Region. (An error is returned when this condition is not true.)
- The AvaTax for Sales integration has been enabled in Chargebee.
The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's TaxJar integration .
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.
A collection of key-value pairs that provides extra information about the addon.
Note: There's a character limit of 65,535.
The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application.
This field is to capture the Account code setup in your Accounting system for integration purposes only.
Used exclusively with the following accounting integrations
- Xero: If you've categorized your products in Xero, provide the category name and option. Use the format:
:. For example:Location: Singapore. - QuickBooks: If you've categorized your product sales in QuickBooks according to Classes, provide the class name here. Use the following format:
::... - NetSuite: If you've categorized your products in NetSuite under Classes, provide the class name here. Use the following format:
: : ....For example:Services : Plan. - Intacct: If you've classified your products in Intacct under Locations, provide the name of the Location here.
Used exclusively with the following accounting integrations
- Xero: If you've categorized your products in Xero, then provide the second category name and option here. Use the format:
: ....For example,Region: South - QuickBooks: If you've categorized your product sales in QuickBooks according to Location, provide the Location name here. Use the following format:
::....For example:Location: North America: Canada - NetSuite: If you've categorized your products in NetSuite under Locations, provide the location name here. Use the following format
: : ....For example:NA:US:CA - Intacct: If you've classified your products in Intacct under Dimensions, provide the value of the Dimension here.
Used exclusively with the following accounting integrations
- NetSuite: If you've categorized your products in NetSuite under Departments, pass the department name here. Use the following format:
: : ....For example:Production: Assembly. - Intacct: If you've classified your products in Intacct under multiple Dimensions, provide the value of the second Dimension here. .
Used exclusively with the following accounting integrations
If enabled, charges for this plan/addon will be added to orders.
Defines the shipping frequency. Example: to bill customer every 2 weeks, provide "2" here.
Defines the shipping frequency in association with shipping period.
Ship based on year(s)
Ship based on month(s)
Ship based on week(s)
Ship based on day(s)
The addon is included in MRR calculations for your site. This attribute is only applicable for addons of charge_type = non_recurring
and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude non-recurring addons from MRR calculations, this value is always returned false
.
Whether the addon description should be shown on invoice PDFs. If this Boolean is changed, only invoices generated (or regenerated ) after the change are affected; past invoices are not.
Whether the addon description should be shown on quote PDFs. If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
The price of the addon when the pricing_model
is flat_fee.
When the pricing model is per_unit
, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when multi-decimal pricing
is enabled.
This price is for the period of the addon. When attached to a plan, the addon is billed for the billing period of the plan. Learn more.
Note
Applicable only for addons with pricing_model = per_unit.
Specifies how to manage charges or credits for the addon during a subscription update or estimating a subscription update.
Use the site-wide proration setting .
Prorate the charges or credits for the rest of the current term.
Charge the full price of the addon item price or give the full credit. Don't apply any proration.
Status of the addon.
Only active addons can be applied to subscriptions
No new associations with subscriptions are allowed. Existing associations for recurring addons remain as-is and can be removed if required.
Returns
Resource object representing addon