Settings
API Version
Product Catalog
Library
Home
Customers
Subscriptions
In App Purchases
Invoices and Credit Notes
Estimates
Orders
Product Catalog
Hosted Pages
Payments
Currencies
Events
Simulation Tools
Quotes
Quotes is available on selected plans only.
A quote is an estimate of the invoice with the charges likely to occur when customers buy an item. A quote can be converted to a regular invoice once the customer accepts it.
The line items of a quote are grouped by charge events and are available as a separate resource. This resource can be retrieved using the List quote line groups endpoint. Note that the first quote line group is available within the quote resource itself and parsing the quote line groups object is not required.
Sample quote [ JSON ]
{
"amount_due": 500,
"amount_paid": 0,
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"object": "billing_address",
"validation_status": "not_validated"
},
"charge_on_acceptance": 500,
"credits_applied": 0,
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWTO25CR",
"date": 1517501504,
"id": "10",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 500,
"customer_id": "__test__KyVnHhSBWTO25CR",
"date_from": 1517501504,
"date_to": 1517501504,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTO5pCa",
"is_taxed": false,
"item_level_discount_amount": 0,
"object": "line_item",
"pricing_model": "flat_fee",
"quantity": 1,
"tax_amount": 0,
"unit_amount": 500
}
],
"object": "quote",
"operation_type": "onetime_invoice",
"price_type": "tax_exclusive",
"resource_version": 1517501504000,
"status": "open",
"sub_total": 500,
"taxes": [],
"total": 500,
"total_payable": 500,
"updated_at": 1517501504,
"valid_till": 1517596199,
"version": 1
}API Index URL GET
https://{site}.chargebee.com/api/v2/quotes
optional, string, max chars=10
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with
When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with
billing_address
country as XI (which is United Kingdom - Northern Ireland).When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting
billing_address
country as XI. That’s the code for United Kingdom - Northern
Ireland. The first two characters of the VAT number in such a case is
XI by default. However, if the VAT number was registered in UK, the value should be GB. Set
vat_number_prefix to GB for such cases.
optional, string, max chars=50
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity. 
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
Note
Multiple Business Entities is a feature available only on Product Catalog 2.0.
Multiple Business Entities is in early access. Submit a request to enable this feature.
optional, list of line_item
The list of line items for this quote.
The list of line items for this quote.
optional, list of discount
The list of all deductions applied to the quote.
The list of all deductions applied to the quote.
optional, list of line_item_discount
The list of deductions applied for each line item of this quote.
The list of deductions applied for each line item of this quote.
optional, list of tax
The list of taxes applicable for this quote.
The list of taxes applicable for this quote.
optional, list of line_item_tax
The list of taxes applied on the line items of this quote.
The list of taxes applied on the line items of this quote.
optional, list of line_item_tier
The list of tiers applicable for the various line items in this quote.
The list of tiers applicable for the various line items in this quote.
optional, shipping_address
Shipping address for the quote.
Shipping address for the quote.
optional, billing_address
Billing address for the quote.
Billing address for the quote.
Retrieve a quote ¶
Retrieves the quotes identified by the 'number' specified in the url.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/10 \
-u {site_api_key}:
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/10 \ -u {site_api_key}:
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/quotes/{quote-id}
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
Sample admin console URL
https://{site}.chargebee.com/admin-console/quotes/123x
Create quote for a new subscription ¶
Idempotency Supported
Creates a quote for a new subscription under the customer specified.
To send this quote, use “Send Email” quote action in the Chargebee application.
Based on the customer’s reply, you can use Update quote status and Convert a quote APIs for changing quote status and invoicing the customer, respectively.
Sample Request
curl https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWTLzbAo/create_subscription_quote \
-u {site_api_key}:\
-d "subscription[plan_id]"="basic"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/customers/__test__KyVnHhSBWTLzbAo/create_subscription_quote \ -u {site_api_key}:\ -d "subscription[plan_id]"="basic"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/customers/{customer-id}/create_subscription_quote
Input Parameters
optional, integer, min=1
The number of subscription billing cycles (including the first one) to invoice in advance.
The number of subscription billing cycles (including the first one) to invoice in advance.
optional, enumerated string
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
optional, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=100
Purchase order number for this subscription.
Purchase order number for this subscription.
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, timestamp(UTC) in seconds
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating is enabled for subscription creation operations.
- The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April,
subscription[start_date]cannot be earlier than 14th February.
optional, enumerated string
The preferred offline payment method for the subscription.
The preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
Show all values[+]optional, integer, min=1, max=100
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
billing_cycles or a custom value depending on the site configuration.
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
optional, enumerated string
Action to be taken when the contract term completes.
Action to be taken when the contract term completes.
Possible values are
renewContract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.optional, integer, default=0
The number of days before
The number of days before
contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, in cents, min=0
The price or per-unit-price of the addon. The value depends on the type of currency.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_priceprovided is $10 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10 on each subscription renewal.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled. optional, integer, min=0
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, timestamp(UTC) in seconds
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support)
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
optional, string, max chars=100
A unique 'id' used to identify the addon.
A unique 'id' used to identify the addon.
optional, integer, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
Defines service period of the addon in days from the day of charge.
optional, enumerated string
Event on which this addon will be charged.
Event on which this addon will be charged.
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
optional, boolean, default=true
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
Edit quote for a new subscription ¶
Idempotency Supported
Edits a quote. This endpoint is for quotes that are for new subscriptions. To edit a quote that is for updating a subscription, use Edit quote for updating a subscription.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/1/edit_create_subscription_quote \
-u {site_api_key}:\
-d "subscription[plan_id]"="basic"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/1/edit_create_subscription_quote \ -u {site_api_key}:\ -d "subscription[plan_id]"="basic"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/edit_create_subscription_quote
Input Parameters
optional, integer, min=1
The number of subscription billing cycles (including the first one) to invoice in advance.
The number of subscription billing cycles (including the first one) to invoice in advance.
optional, enumerated string
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
Override the billing alignment mode for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site.
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
optional, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=100
Purchase order number for this subscription.
Purchase order number for this subscription.
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, timestamp(UTC) in seconds
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately on quote conversion. The quote can be converted on a date/time after this date. This is called backdating the subscription creation and is done when the subscription has already been provisioned but the conversion action has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating is enabled for subscription creation operations.
- The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April,
subscription[start_date]cannot be earlier than 14th February.
optional, enumerated string
The preferred offline payment method for the subscription.
The preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
Show all values[+]optional, integer, min=1, max=100
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
billing_cycles or a custom value depending on the site configuration.
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
optional, enumerated string
Action to be taken when the contract term completes.
Action to be taken when the contract term completes.
Possible values are
renewContract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.optional, integer, default=0
The number of days before
The number of days before
contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, in cents, min=0
The price or per-unit-price of the addon. The value depends on the type of currency.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_priceprovided is $10 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10 on each subscription renewal.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled. optional, integer, min=0
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, timestamp(UTC) in seconds
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support)
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
optional, string, max chars=100
A unique 'id' used to identify the addon.
A unique 'id' used to identify the addon.
optional, integer, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
Defines service period of the addon in days from the day of charge.
optional, enumerated string
Event on which this addon will be charged.
Event on which this addon will be charged.
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
optional, boolean, default=true
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
Create quote for updating a subscription ¶
Idempotency Supported
Creates a quote for updating a subscription under the customer specified.
To send this quote, use “Send Email” quote action in the Chargebee application.
Based on the customer’s reply, you can use Update quote status and Convert a quote APIs for changing quote status and invoicing the customer, respectively.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/update_subscription_quote \
-u {site_api_key}:\
-d "subscription[id]"="__test__KyVnHhSBWTMBNBB" \
-d "subscription[plan_id]"="no_trial" \
-d "billing_address[first_name]"="John" \
-d "billing_address[last_name]"="Doe" \
-d "billing_address[line1]"="PO Box 9999" \
-d "billing_address[city]"="Walnut" \
-d "billing_address[state]"="California" \
-d "billing_address[zip]"="91789" \
-d "billing_address[country]"="US"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/update_subscription_quote \ -u {site_api_key}:\ -d "subscription[id]"="__test__KyVnHhSBWTMBNBB" \ -d "subscription[plan_id]"="no_trial" \ -d "billing_address[first_name]"="John" \ -d "billing_address[last_name]"="Doe" \ -d "billing_address[line1]"="PO Box 9999" \ -d "billing_address[city]"="Walnut" \ -d "billing_address[state]"="California" \ -d "billing_address[zip]"="91789" \ -d "billing_address[country]"="US"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/update_subscription_quote
Input Parameters
optional, integer, min=1
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.
optional, timestamp(UTC) in seconds
If the subscription
Note: It is recommended not to pass this parameter along with
If the subscription
status is cancelled and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.Note: It is recommended not to pass this parameter along with
changed_scheduled_at. reactivate_from can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating must be enabled for subscription reactivation operations.
- The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
- The date is on or after the last date/time any of the product catalog items of the subscription were changed.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April,
changes_scheduled_atcannot be earlier than 14th February.
optional, enumerated string
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
optional, enumerated string
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
Possible values are
immediatelyThe change is carried out immediately.specific_dateThe change is carried out as of the date specified under
changes_scheduled_at.
optional, timestamp(UTC) in seconds
When
When
change_option is set to specific_date, then set the date/time at which the subscription change is to happen or has happened. changes_scheduled_at can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating must be enabled for subscription change operations.
- Only the following changes can be backdated:
- Changes in the recurring items or their prices.
- Addition of non-recurring items.
- Subscription
statusisactive,cancelled, ornon_renewing. - The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
- The date is on or after
current_term_start. - The date is on or after the last date/time any of the following changes were made:
- Changes in the recurring items or their prices.
- Addition of non-recurring items.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription’s plan is 2 months and today is 14th April,
changes_scheduled_atcannot be earlier than 14th February.
Note: The
changes_scheduled_at parameter does not apply to auto_collection, shipping_address, and po_number; these parameters take effect immediately when scheduling a subscription update.
optional, boolean, default=false
Applicable for 'Active' & 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
Note: Specifying this value as 'false' has no impact on the default behaviour.
Applicable for 'Active' & 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
Note: Specifying this value as 'false' has no impact on the default behaviour.
optional, boolean
Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
required, string, max chars=50
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, integer, default=1, min=1
Represents the plan quantity for this subscription.
Represents the plan quantity for this subscription.
optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, timestamp(UTC) in seconds
The new start date of a
The new start date of a
future subscription. Applicable only for future subscriptions. optional, timestamp(UTC) in seconds
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription
status is future, in_trial, or cancelled. Also, the value must not be earlier than changes_scheduled_at or start_date. Note: This parameter can be backdated (set to a value in the past) only when the subscription is in cancelled or in_trial status. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end is backdated, the subscription immediately goes into active or non_renewing status. optional, enumerated string
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
optional, enumerated string
The preferred offline payment method for the subscription.
The preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
Show all values[+]optional, integer, min=1, max=100
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
billing_cycles or a custom value depending on the site configuration.
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
optional, string, max chars=20
VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
optional, string, max chars=10
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with
When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with
billing_address
country as XI (which is United Kingdom - Northern Ireland).When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting
billing_address
country as XI. That’s the code for United Kingdom - Northern
Ireland. The first two characters of the VAT number in such a case is
XI by default. However, if the VAT number was registered in UK, the value should be GB. Set
vat_number_prefix to GB for such cases. optional, boolean
Confirms that a customer is registered under GST. If set to
Confirms that a customer is registered under GST. If set to
true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
optional, enumerated string, default=renew
Action to be taken when the contract term completes.
Action to be taken when the contract term completes.
Possible values are
renewContract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following: Contract term completes and a new contract term is started for the number of billing cycles specified in The
contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.optional, integer
The number of days before
The number of days before
contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, in cents, min=0
The price or per-unit-price of the addon. The value depends on the type of currency.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_priceprovided is $10 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10 on each subscription renewal.
optional, integer, min=0
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled. optional, timestamp(UTC) in seconds
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
replace_addon_list. (Addon trial periods must be enabled by Chargebee Support.)
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
optional, string, max chars=100
A unique 'id' used to identify the addon.
A unique 'id' used to identify the addon.
optional, integer, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
Defines service period of the addon in days from the day of charge.
optional, enumerated string
Indicates when the non-recurring addon will be charged.
Indicates when the non-recurring addon will be charged.
Possible values are
immediatelyCharges for the addon will be applied immediately.on_eventCharge for the addon will be applied on the occurrence of a specified event.
optional, enumerated string
Event on which this addon will be charged.
Event on which this addon will be charged.
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
optional, boolean, default=true
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addonis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addonis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
Edit quote for updating a subscription ¶
Idempotency Supported
Edits a quote. This endpoint is for editing quotes that are for updating a subscription. To edit a quote for a new subscription, use Edit quote for a new subscription.”
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/1/edit_update_subscription_quote \
-u {site_api_key}:\
-d "subscription[plan_id]"="no_trial" \
-d "billing_address[first_name]"="John" \
-d "billing_address[last_name]"="Doe" \
-d "billing_address[line1]"="PO Box 9999" \
-d "billing_address[city]"="Walnut" \
-d "billing_address[state]"="California" \
-d "billing_address[zip]"="91789" \
-d "billing_address[country]"="US"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/1/edit_update_subscription_quote \ -u {site_api_key}:\ -d "subscription[plan_id]"="no_trial" \ -d "billing_address[first_name]"="John" \ -d "billing_address[last_name]"="Doe" \ -d "billing_address[line1]"="PO Box 9999" \ -d "billing_address[city]"="Walnut" \ -d "billing_address[state]"="California" \ -d "billing_address[zip]"="91789" \ -d "billing_address[country]"="US"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/edit_update_subscription_quote
Input Parameters
optional, integer, min=1
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
The number of subscription billing cycles to invoice in advance. If a new term is started for the subscription due to this API call, then
terms_to_charge is inclusive of this new term. See description for the force_term_reset parameter to learn more about when a subscription term is reset.
optional, timestamp(UTC) in seconds
If the subscription
Note: It is recommended not to pass this parameter along with
If the subscription
status is cancelled and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.Note: It is recommended not to pass this parameter along with
changed_scheduled_at. reactivate_from can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating must be enabled for subscription reactivation operations.
- The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
- The date is on or after the last date/time any of the product catalog items of the subscription were changed.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April,
changes_scheduled_atcannot be earlier than 14th February.
optional, enumerated string
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
Possible values are
immediateSubscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..delayedSubscription period will be aligned with the configured billing date at the next renewal.
optional, enumerated string
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out.
Possible values are
immediatelyThe change is carried out immediately.specific_dateThe change is carried out as of the date specified under
changes_scheduled_at.
optional, timestamp(UTC) in seconds
When
When
change_option is set to specific_date, then set the date/time at which the subscription change is to happen or has happened. changes_scheduled_at can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
- Backdating must be enabled for subscription change operations.
- Only the following changes can be backdated:
- Changes in the recurring items or their prices.
- Addition of non-recurring items.
- Subscription
statusisactive,cancelled, ornon_renewing. - The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
- The date is on or after
current_term_start. - The date is on or after the last date/time any of the following changes were made:
- Changes in the recurring items or their prices.
- Addition of non-recurring items.
- The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the subscription’s plan is 2 months and today is 14th April,
changes_scheduled_atcannot be earlier than 14th February.
optional, boolean, default=false
Applicable for 'Active' & 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
Note: Specifying this value as 'false' has no impact on the default behaviour.
Applicable for 'Active' & 'Non Renewing' states alone. Generally, subscription's term will be reset (i.e current term is ended and a new term starts immediately) when a new plan having different billing frequency is specified in the input. For all the other cases, the subscription's term will remain intact. Now for this later scenario, if you want to force a term reset you can specify this param as 'true'.
Note: Specifying this value as 'false' has no impact on the default behaviour.
optional, boolean
Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
optional, integer, default=1, min=1
Represents the plan quantity for this subscription.
Represents the plan quantity for this subscription.
optional, in cents, min=0
Amount that will override the Plan's default price. The unit depends on the type of currency.
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, string, max chars=33
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the plan can be set here. The value set for the plan is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
optional, timestamp(UTC) in seconds
The new start date of a
The new start date of a
future subscription. Applicable only for future subscriptions. optional, timestamp(UTC) in seconds
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription
The time at which the trial has ended or will end for the subscription. This is only allowed when the subscription
status is future, in_trial, or cancelled. Also, the value must not be earlier than changes_scheduled_at or start_date. Note: This parameter can be backdated (set to a value in the past) only when the subscription is in cancelled or in_trial status. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end is backdated, the subscription immediately goes into active or non_renewing status. optional, enumerated string
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
optional, enumerated string
The preferred offline payment method for the subscription.
The preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transfer
Show all values[+]optional, integer, min=1, max=100
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
billing_cycles or a custom value depending on the site configuration.
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
optional, string, max chars=20
VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
VAT number of this customer. If not provided then taxes are not calculated for the estimate. Applicable only when taxes are configured for the EU or UK region. VAT validation is not done for this.
optional, string, max chars=10
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with
When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with
billing_address
country as XI (which is United Kingdom - Northern Ireland).When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting
billing_address
country as XI. That’s the code for United Kingdom - Northern
Ireland. The first two characters of the VAT number in such a case is
XI by default. However, if the VAT number was registered in UK, the value should be GB. Set
vat_number_prefix to GB for such cases. optional, boolean
Confirms that a customer is registered under GST. If set to
Confirms that a customer is registered under GST. If set to
true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
optional, enumerated string, default=renew
Action to be taken when the contract term completes.
Action to be taken when the contract term completes.
Possible values are
renewContract term completes and a new contract term is started for the number of billing cycles specified in The evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.renew_onceUsed when you want to renew the contract term just once. Does the following: Contract term completes and a new contract term is started for the number of billing cycles specified in The
contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.contract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to cancel.optional, integer
The number of days before
The number of days before
contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, in cents, min=0
The price or per-unit-price of the addon. The value depends on the type of currency.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_priceprovided is $10 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10 on each subscription renewal.
optional, integer, min=0
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
Number of billing cycles the addon will be charged for. When not set, the addon is attached to the subscription for an indefinite number of billing cycles. While updating a subscription to a plan with a different billing period, set this parameter again or its value will be lost. And so, the addon will be attached indefinitely.
optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addon is used by default. However, the price provided here is considered as the price of the addon for an entire billing cycle of the subscription regardless of the value of the addon
period. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled. optional, timestamp(UTC) in seconds
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
replace_addon_list. (Addon trial periods must be enabled by Chargebee Support.)
Parameters for event_based_addons. Multiple event_based_addons can be passed by specifying unique indices.
pass parameters as event_based_addons[<param name>][<idx:0..n>]
pass parameters as event_based_addons[<param name>][<idx:0..n>]
optional, string, max chars=100
A unique 'id' used to identify the addon.
A unique 'id' used to identify the addon.
optional, integer, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, in cents, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
Defines service period of the addon in days from the day of charge.
optional, enumerated string
Indicates when the non-recurring addon will be charged.
Indicates when the non-recurring addon will be charged.
Possible values are
immediatelyCharges for the addon will be applied immediately.on_eventCharge for the addon will be applied on the occurrence of a specified event.
optional, enumerated string
Event on which this addon will be charged.
Event on which this addon will be charged.
Possible values are
subscription_creationAddon will be charged on subscription creation.subscription_trial_startAddon will be charged when the trial period starts.plan_activationAddon will be charged on plan activation.subscription_activationAddon will be charged on subscription activation.contract_terminationAddon will be charged on contract termination.
optional, boolean, default=true
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, string, max chars=33
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when multi-decimal pricing is enabled.
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addonis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
When price overriding is enabled for the site, the price or per-unit price of the addon can be set here. The value set for the addonis used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
Create quote for one-time charges ¶
Idempotency Supported
Creates a quote for one-time charges and non-recurring addons. This is applicable only for one-time payment. Recurring charges are not permitted in this quote; use Create quote for a new subscription or Create quote for updating a subscription instead.
To send this quote, use “Send Email” quote action in the Chargebee application.
Based on the customer’s reply, you can use Update quote status and Convert a quote APIs for changing quote status and invoicing the customer, respectively.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/create_for_onetime_charges \
-u {site_api_key}:\
-d customer_id="__test__KyVnHhSBWTM5WB0" \
-d "charges[amount][0]"=1000 \
-d "charges[description][0]"="Service Charge"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/create_for_onetime_charges \ -u {site_api_key}:\ -d customer_id="__test__KyVnHhSBWTM5WB0" \ -d "charges[amount][0]"=1000 \ -d "charges[description][0]"="Service Charge"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/create_for_onetime_charges
Input Parameters
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, string, max chars=33
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, in cents, min=0
The price or per-unit-price of the addon. The value depends on the type of currency.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_priceprovided is $10 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10 on each subscription renewal.
optional, string, max chars=39
The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_price_in_decimalprovided is $10.75 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10.75 on each subscription renewal.
optional, integer
Specifies the service period of the addon in days. When the quote is converted, the
Specifies the service period of the addon in days. When the quote is converted, the
invoice.line_item.date_from is set to current date/time and invoice.line_item.date_to is set to service_period days ahead of date_from.
Parameters for charges. Multiple charges can be passed by specifying unique indices.
pass parameters as charges[<param name>][<idx:0..n>]
pass parameters as charges[<param name>][<idx:0..n>]
optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.
The amount to be charged. The unit depends on the type of currency.
optional, string, max chars=39
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.
optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
optional, integer
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 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.
optional, integer
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.
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.
Parameters for tax_providers_fields. Multiple tax_providers_fields can be passed by specifying unique indices.
pass parameters as tax_providers_fields[<param name>][<idx:0..n>]
pass parameters as tax_providers_fields[<param name>][<idx:0..n>]
optional, string, max chars=50
Name of the tax provider currently supported.
Name of the tax provider currently supported.
optional, string, max chars=50
Field id of the attribute which tax vendor has provided while getting onboarded with us.
Field id of the attribute which tax vendor has provided while getting onboarded with us.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
Edit quote for one-time charges ¶
Idempotency Supported
Edits a quote. The quote must be for one-time charges or non-recurring addons.
To edit quotes created for subscriptions, use:
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/6/edit_one_time_quote \
-X POST \
-u {site_api_key}:\
-d "charges[amount][0]"=1000 \
-d "charges[description][0]"="Service Charge"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/6/edit_one_time_quote \ -X POST \ -u {site_api_key}:\ -d "charges[amount][0]"=1000 \ -d "charges[description][0]"="Service Charge"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/edit_one_time_quote
Input Parameters
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
optional, string, max chars=50
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC). optional, string, max chars=50
The state/province name. Is set by Chargebee automatically for US, Canada and India If
The state/province name. Is set by Chargebee automatically for US, Canada and India If
state_code is provided. optional, string, max chars=20
Zip or postal code. The number of characters is validated according to the rules specified here.
Zip or postal code. The number of characters is validated according to the rules specified here.
optional, string, max chars=50
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Note: If you enter an invalid country code, the system will return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI (the code for United Kingdom – Northern Ireland) is available as an option.
optional, enumerated string, default=not_validated
The address verification status.
The address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
pass parameters as addons[<param name>][<idx:0..n>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with
Quantity of the addon. Applicable for addons with
pricing_model other than flat_fee. optional, string, max chars=33
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, in cents, min=0
The price or per-unit-price of the addon. The value depends on the type of currency.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_priceprovided is $10 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10 on each subscription renewal.
optional, string, max chars=39
The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.
Note:
For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:
- The
unit_price_in_decimalprovided is $10.75 - The addon billing period is 1 month.
- The plan billing period is 3 months.
- The addon is only billed for $10.75 on each subscription renewal.
optional, integer
Specifies the service period of the addon in days. When the quote is converted, the
Specifies the service period of the addon in days. When the quote is converted, the
invoice.line_item.date_from is set to current date/time and invoice.line_item.date_to is set to service_period days ahead of date_from.
Parameters for charges. Multiple charges can be passed by specifying unique indices.
pass parameters as charges[<param name>][<idx:0..n>]
pass parameters as charges[<param name>][<idx:0..n>]
optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.
The amount to be charged. The unit depends on the type of currency.
optional, string, max chars=39
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.
optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
optional, integer
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 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.
optional, integer
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.
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.
Parameters for tax_providers_fields. Multiple tax_providers_fields can be passed by specifying unique indices.
pass parameters as tax_providers_fields[<param name>][<idx:0..n>]
pass parameters as tax_providers_fields[<param name>][<idx:0..n>]
optional, string, max chars=50
Name of the tax provider currently supported.
Name of the tax provider currently supported.
optional, string, max chars=50
Field id of the attribute which tax vendor has provided while getting onboarded with us.
Field id of the attribute which tax vendor has provided while getting onboarded with us.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
List quotes ¶
List all quotes.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes \
-G \
-u {site_api_key}:\
--data-urlencode limit=3 \
--data-urlencode "status[in]"=["accepted"] \
--data-urlencode "sort_by[asc]"=date
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes \ -G \ -u {site_api_key}:\ --data-urlencode limit=3 \ --data-urlencode "status[in]"=["accepted"] \ --data-urlencode "sort_by[asc]"=date
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/quotes
Input Parameters
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
next_offset
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`.
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`.
List quote line groups ¶
This API retrieves all the quote line groups and lineitems for a quote.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/9/quote_line_groups \
-G \
-u {site_api_key}:
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/9/quote_line_groups \ -G \ -u {site_api_key}:
Sample Response [ JSON ]
URL Format GET
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/quote_line_groups
Input Parameters
Returns
quote_line_group quote_line_group
always returned required
Resource object representing quote_line_group
Resource object representing quote_line_group
next_offset
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`.
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`.
Convert a quote ¶
Idempotency Supported
This API is to convert a quote to an invoice.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/1/convert \
-X POST \
-u {site_api_key}:
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/1/convert \ -X POST \ -u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/convert
Input Parameters
optional, timestamp(UTC) in seconds
The document date displayed on the invoice PDF. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. When not provided, the value is the same as current date. Moreover, if the invoice is created as
The document date displayed on the invoice PDF. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. When not provided, the value is the same as current date. Moreover, if the invoice is created as
pending, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of invoice_date. When passing this parameter, the following prerequisites must be met:
invoice_datemust be in the past.invoice_dateis not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.- The date is not earlier than
quoted_subscription.start_dateorquoted_subscription.changes_scheduled_at(whichever is applicable). invoice_immediatelymust betrue.
optional, boolean
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings.
Note:
. invoice_immediately only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
optional, enumerated string
Applicable only for create subscription quote.
Applicable only for create subscription quote.
Possible values are
onWhenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.offAutomatic collection of charges will not be made for this subscription. Use this for offline payments.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
customer customer
always returned required
Resource object representing customer
Resource object representing customer
subscription subscription
always returned optional
Resource object representing subscription
Resource object representing subscription
invoice invoice
always returned optional
Resource object representing invoice
Resource object representing invoice
credit_note credit_note
always returned optional
Resource object representing credit_note
Resource object representing credit_note
unbilled_charges unbilled_charges
always returned optional
Resource object representing unbilled_charges
Resource object representing unbilled_charges
Update quote status ¶
Idempotency Supported
Updates the status of the quote. Status can be updated to Accepted, Declined, and Closed.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/11/update_status \
-u {site_api_key}:\
-d status="ACCEPTED"
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/11/update_status \ -u {site_api_key}:\ -d status="ACCEPTED"
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/update_status
Input Parameters
optional, string, max chars=300
An internal comment to be added for this operation, to the quote. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Quote PDF.
An internal comment to be added for this operation, to the quote. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Quote PDF.
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
Extend expiry date ¶
Idempotency Supported
Can be used to extend the expiry date of a quote.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/10/extend_expiry_date \
-u {site_api_key}:\
-d valid_till=1581791399
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/10/extend_expiry_date \ -u {site_api_key}:\ -d valid_till=1581791399
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/extend_expiry_date
Input Parameters
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
Delete a quote ¶
Idempotency Supported
Delete an existing quote using this API.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/5/delete \
-X POST \
-u {site_api_key}:
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/5/delete \ -X POST \ -u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/delete
Input Parameters
Returns
quote quote
always returned required
Resource object representing quote
Resource object representing quote
quoted_subscription quoted_subscription
always returned optional
Resource object representing quoted_subscription
Resource object representing quoted_subscription
quoted_charge quoted_charge
always returned optional
Resource object representing quoted_charge
Resource object representing quoted_charge
Retrieve quote as PDF ¶
Idempotency Supported
Retrieves the quote as a PDF. The returned URL is secure, allows download and expires in 60 minutes.
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/9/pdf \
-X POST \
-u {site_api_key}:
copy
Click to Copy
curl https://{site}.chargebee.com/api/v2/quotes/9/pdf \ -X POST \ -u {site_api_key}:
Sample Response [ JSON ]
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote-id}/pdf
Input Parameters
Returns
download download
always returned required
Resource object representing download
Resource object representing download