POST /addons
Create a new addon.
Servers
- {protocol}://{site}.{environment}:{port}/api/v1
- {protocol}://{site}-test.{environment}:{port}/api/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
chargebee-event-webhook |
String | No |
skip only webhooks Possible values:
|
chargebee-event-actions |
String | No |
skip all actions to be done on the events Possible values:
|
chargebee-request-origin-user |
String | No |
The email address of your customer/user. Use this when the email address has only ASCII characters. |
chargebee-request-origin-ip |
String | No |
The IP address of the customer where the request originated |
chargebee-request-origin-user-encoded |
String | No |
The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header |
chargebee-event-email |
String | No |
skip only emails Possible values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
invoice_name |
String | No |
Display name used in invoice. If it is not configured then name is used in invoice. |
price |
Integer | No |
Addon price is calculated based on the addon type and charge type. Learn more. The unit depends on the type of currency. |
description |
String | No |
Description about the addon to show in the hosted pages & customer portal. This description will not be shown if multiple addons are added. |
meta_data |
Object | No |
A set of key-value pairs stored as additional information for the addon. [Learn more](./#meta_data). |
invoice_notes |
String | No |
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. |
unit |
String | No |
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. |
id |
String | Yes |
A unique ID for your system to identify the addon. |
period_unit |
String | No |
Applicable only for recurring-addons. Along with 'period' decides the term-price of this addon. * year - Charge based on year(s) * month - Charge based on month(s) * not_applicable - not applicable for this addon * week - Charge based on week(s) * day - Charge based on Day(S) Possible values:
|
name |
String | Yes |
The display name used in web interface for identifying the addon. |
period |
Integer | No |
Applicable only for recurring-addons. Along with 'period_unit' decides the term-price of this addon. |
proration_type |
String | No |
null Possible values:
Default value: "site_default" |
type |
String | No |
Select "On-Off" to charge a flat fee or "Quantity" for unit based charges. * quantity - Charges this price for every unit of the addon. Example: 2 additional support agents at $10 each * on_off - Addon that does not have any quantity associated and can only be enabled or disabled. Example: On call support at $99 per month. Possible values:
|
taxable |
Boolean | No |
Specifies if the addon should be taxed or not. Default value: true |
charge_type |
String | Yes |
Type of charge. * recurring - Charges are automatically applied in sync with the billing frequency of subscription. * non_recurring - Charged immediately and only once every time it is applied. Possible values:
Default value: "recurring" |
enabled_in_portal |
Boolean | No |
If enabled, customers can select this addon using the 'Change Subscription' option in the customer portal. Default value: true |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.