This endpoint creates a new plan based on the plan Id and plan name.
Sample Request
URL Format
Input Parameters
Display name used in invoice. If it is not configured then name is used in invoice.
Description about the plan to show in the hosted pages & customer portal. 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.
Applicable only when End-of-trial Action has been enabled for the site. Whenever the plan has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. This can be overridden at the subscription-level .
The action configured for the site at the time when the trial ends, takes effect.
The subscription activates and charges are raised for non-metered items.
The subscription cancels.
Defines billing frequency. Example: to bill customer every 3 months, provide "3" here.
Defines billing frequency in association with billing period.
Charge based on day(s)
Charge based on week(s)
Charge based on month(s)
Charge based on year(s)
The price of the plan when the pricing_model
is flat_fee.
When the pricing model is per_unit
, it is the price per unit quantity of the plan. 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. .
The currency code (ISO 4217 format) of the plan.
The number of billing cycles the subscription is active. The subscription is moved to non renewing state and then to cancelled state automatically.
Defines how the recurring charges for the subscription is 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.
Free quantity the subscriptions of this plan will have. Only the quantity more than this will be charged for the subscription.
The quantity of the plan that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when multi-decimal pricing is enabled. .
Indicates if all or only some addons are applicable with the plan.
All addons are applicable with this plan.
Only addons marked as 'applicable_addons' are applicable with the plan.
The url to redirect on successful checkout. Eg: https://yoursite.com/success.html?plan=basic.
If true, allow checkout through plan specific hosted page URL for this plan.
If enabled, customers can switch to this plan using the 'Change Subscription' option in the customer portal.
Specifies whether taxes apply to this plan. This value is set and returned even if Taxes have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
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 .
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 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)
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 plan.
Note: There's a character limit of 65,535.
Whether the plan.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 plan 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 plan state.
New subscriptions can be created with the plan.
No new subscriptions allowed for the plan. Existing subscriptions on this plan will remain as-is and can be migrated to another active plan if required.
The url to redirect on successful claim. Eg: https://yoursite.com/claim_success.html?plan=basic.
Returns
Resource object representing plan