- Home
- 3DS Card Payments
- Subscriptions
- Customers
- Payment sources
- Virtual bank accounts
- Cards
- Promotional credits
- Invoices
- Credit notes
- Unbilled charges
- Orders
- Gifts
- Transactions
- Hosted pages
- Estimates
- Quotes
- Plans
- Addons
- Coupons
- Coupon sets
- Coupon codes
- Addresses
- Events
- Comments
- Downloads
- Portal sessions
- Site migration details
- Time machines
- Exports
- Payment intents
- Open Source
- Chargebee JS
- Payment parameters
Quotes
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
The quote number. Acts as a identifier for quote and typically generated sequentially.
string, max chars=50
string, max chars=50
The identifier of the subscription this quote belongs to.
optional, string, max chars=50
optional, string, max chars=50
The identifier of the invoice generated while converting this quote.
optional, string, max chars=50
optional, string, max chars=50
Current status of this quote.
enumerated string
enumerated string
Possible values are
openOpen.acceptedAccepted.declinedDeclined.invoicedInvoiced.closedClosed.
Operation Type.
enumerated string
enumerated string
Possible values are
create_subscription_for_customercreate_subscription_for_customer.change_subscriptionchange_subscription.onetime_invoiceonetime_invoice.
The price type of the quote.
enumerated string, default=tax_exclusive
enumerated string, default=tax_exclusive
Possible values are
tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.
Quote will be valid till this date. After this date quote will be marked as closed.
timestamp(UTC) in seconds
timestamp(UTC) in seconds
Creation date of the quote. Typically this is the date on which quote is generated.
timestamp(UTC) in seconds
timestamp(UTC) in seconds
Total contract value. Applicable when multi billing cycle quote is enabled.
optional, in cents, min=0
optional, in cents, min=0
Charge on acceptance. Applicable when multi billing cycle quote is enabled.
optional, in cents, default=0, min=0
optional, in cents, default=0, min=0
Credits applied (in cents) for the first quote line group.
optional, in cents, default=0, min=0
optional, in cents, default=0, min=0
Existing outstanding payments (in cents) if any, applied to the first quote line group.
optional, in cents, default=0, min=0
optional, in cents, default=0, min=0
Amount due (in cents) for the first quote line group.
optional, in cents, default=0, min=0
optional, in cents, default=0, min=0
Version number of this resource. Each update of this resource results in incremental change of this number. This attribute will be present only if the resource has been updated after 2016-09-28.
optional, long
optional, long
Timestamp indicating when this quote was last updated.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Specifies the contract term’s end date. It indicates when the action set in
optional, timestamp(UTC) in seconds
action_at_term_end gets triggered.optional, timestamp(UTC) in seconds
Specifies the charge to be applied for terminating the contract term.
optional, in cents, min=0
optional, in cents, min=0
The list of items for the first quote line group.
optional, list of line_item
optional, list of line_item
Line item attributes
A unique identifier for the subscription this line item belongs to.
optional, string, max chars=3
optional, string, max chars=3
Total amount of this line item. Typically equals to unit amount x quantity.
optional, in cents
optional, in cents
The
pricing scheme for this item.
optional, enumerated string
optional, enumerated string
Possible values are
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThe per unit price is based on the tier that the total quantity falls in.volumeThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.stairstepA quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.The decimal representation of the unit amount of the
optional, string, max chars=33
line_item. The value is in major units of the currency. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.optional, string, max chars=33
The decimal representation of the quantity of this line_item. Returned when the
optional, string, max chars=33
line_item is quantity-based and multi-decimal pricing is enabled.optional, string, max chars=33
The decimal representation of the amount for the
optional, string, max chars=33
line_item, in major units of the currency. Typically equals to unit_amount_in_decimal x quantity_in_decimal. Returned when multi-decimal pricing is enabled.optional, string, max chars=33
Specifies the modelled entity this line item is based on.
enumerated string
enumerated string
Possible values are
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan id.planIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan id.addonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon id.adhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case.The reason due to which the line item price/amount is exempted from tax.
optional, enumerated string
optional, enumerated string
Possible values are
tax_not_configuredIf tax is not enabled for the site.region_non_taxableIf the product sold is not taxable in this region, but it is taxable in other regions, hence this region is not part of the Taxable jurisdiction.exportYou are not registered for tax in the customer’s region. This is also the reason code when both billing_address and shipping_address have not been provided for the customer and subscription respectively.customer_exemptIf the Customer is marked as Tax exempt.product_exemptIf the Plan or Addon is marked as Tax exempt.zero_ratedIf the rate of tax is 0% and no Sales/ GST tax is collectable for that line item.reverse_chargeIf the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU only.high_value_physical_goodsIf physical goods are sold from outside Australia to customers in Australia, and the price of all the physical good line items is greater than AUD 1000, then tax will not be applied.The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type.
optional, string, max chars=100
optional, string, max chars=100
The list of discounts applied to the first quote line group.
optional, list of discount
optional, list of discount
Discount attributes
Type of this Discount line item.
enumerated string
enumerated string
Possible values are
item_level_couponRepresents the 'Item' level coupons applied to this invoice. Further the 'entity_id' attribute specifies the coupon id this discount is based on.document_level_couponRepresents the 'Document' level coupons applied to this document. Further the 'entity_id' attribute specifies the coupon id this discount is based on.promotional_creditsRepresents the Promotional Credits item in invoice. The 'entity_id' attribute will be null in this case.prorated_creditsRepresents the credit adjustment items in invoice. The 'entity_id' attribute will be null in this case.
The list of discount(s) applied for each line item of the first quote line group.
optional, list of line_item_discount
optional, list of line_item_discount
Line item discount attributes
The unique reference id of the line item for which the discount is applicable.
string, max chars=50
string, max chars=50
Type of this discount line item.
enumerated string
enumerated string
Possible values are
item_level_couponRepresents the 'Item' level coupons applied to this invoice. Further the 'coupon_id' attribute specifies the coupon id this discount is based on.document_level_couponRepresents the 'Document' level coupons applied to this document. Further the 'coupon_id' attribute specifies the coupon id this discount is based on.promotional_creditsRepresents the Promotional Credits item in invoice. The 'coupon_id' attribute will be null in this case.prorated_creditsRepresents the credit adjustment items in invoice. The 'coupon_id' attribute will be null in this case.
The list of taxes applied to the first quote line group.
optional, list of tax
optional, list of tax
The list of taxes applied on line items of the first quote line group.
optional, list of line_item_tax
optional, list of line_item_tax
Line item tax attributes
The unique reference id of the line item for which the tax is applicable.
optional, string, max chars=40
optional, string, max chars=40
Indicates if tax is applied only on a portion of the line item amount.
optional, boolean
optional, boolean
Indicates the non-compliance tax that should not be reported to the jurisdiction.
optional, boolean
optional, boolean
The type of tax jurisdiction.
optional, enumerated string
optional, enumerated string
Possible values are
countryThe tax jurisdiction is a country.federalThe tax jurisdiction is a federal.stateThe tax jurisdiction is a state.countyThe tax jurisdiction is a county.cityThe tax jurisdiction is a city.specialSpecial tax jurisdiction.unincorporatedCombined tax of state and county.otherJurisdictions other than the ones listed above.Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
optional, in cents, min=0
optional, in cents, min=0
The list of pricing tiers applicable for the line items of the first quote line group.
optional, list of line_item_tier
optional, list of line_item_tier
Line item tier attributes
The price of the tier if the charge model is a
in cents, min=0
stairtstep pricing , or the price of each unit in the tier if the charge model is tiered/volume pricing.in cents, min=0
The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as
optional, string, max chars=33
ending_unit_in_decimal of the next lower tier. Returned only when the line_items.pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.optional, string, max chars=33
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the
optional, string, max chars=33
starting_unit_in_decimal of the next higher tier. Returned only when the line_items.pricing_model is tiered, volume or stairstep and multi-decimal pricing is enabled.optional, string, max chars=33
The decimal representation of the quantity purchased from this tier. Returned when the
optional, string, max chars=33
line_item is quantity-based and multi-decimal pricing is enabled.optional, string, max chars=33
The decimal representation of the per-unit price for the tier when the
optional, string, max chars=40
pricing_model is tiered or volume. When the pricing_model is stairstep, it is the decimal representation of the total price for line_item. The value is in major units of the currency. Returned when the line_item is quantity-based and multi-decimal pricing is enabled.optional, string, max chars=40
Shipping address for the quote.
optional, shipping_address
optional, shipping_address
Shipping addres attributes
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
Billing address for the quote.
optional, billing_address
optional, billing_address
Billing addres attributes
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
Retrieve a quote¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/10 \
-u {site_api_key}:
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
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Sample admin console URL
https://{site}.chargebee.com/admin-console/quotes/123x
Create quote for a new subscription¶
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
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
Notes specific to this quote that you want customers to see on the quote PDF.
optional, string, max chars=2000
optional, string, max chars=2000
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The number of subscription billing cycles (including the first one) to invoice in advance.
optional, integer, min=1
optional, integer, min=1
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.
optional, enumerated string
optional, enumerated string
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.
Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string
optional, list of string
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=50
optional, string, max chars=50
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
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.
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=33
optional, string, max chars=33
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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, string, max chars=33
optional, string, max chars=33
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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
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. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=cancel
Contract 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.
optional, enumerated string, default=cancel
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.
The number of days before
optional, integer, default=0
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.optional, integer, default=0
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>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
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=33
optional, string, max chars=33
Amount that will override the Addon's default price. The unit depends on the type of currency. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
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
optional, string, max chars=33
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, string, max chars=33
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, integer, min=1
optional, integer, min=1
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
optional, timestamp(UTC) in seconds
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
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>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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=33
optional, string, max chars=33
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, string, max chars=33
optional, string, max chars=33
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
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.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean, default=true
optional, boolean, default=true
Returns
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Edit quote for a new subscription¶
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
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
Notes specific to this quote that you want customers to see on the quote PDF.
optional, string, max chars=2000
optional, string, max chars=2000
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
optional, integer, min=0
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The number of subscription billing cycles (including the first one) to invoice in advance.
optional, integer, min=1
optional, integer, min=1
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.
optional, enumerated string
optional, enumerated string
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.
Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string
optional, list of string
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=50
optional, string, max chars=50
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=33
optional, string, max chars=33
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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, string, max chars=33
optional, string, max chars=33
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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
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. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=cancel
Contract 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.
optional, enumerated string, default=cancel
Possible values are
renewcontract_billing_cycle_on_renewal.action_at_term_end for the new contract term is set to renew.
The number of days before
optional, integer, default=0
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.optional, integer, default=0
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>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
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=33
optional, string, max chars=33
Amount that will override the Addon's default price. The unit depends on the type of currency. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
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
optional, string, max chars=33
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, string, max chars=33
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, integer, min=1
optional, integer, min=1
The time at which the trial ends for the addon. This value can only be set for subscriptions that start with an
optional, timestamp(UTC) in seconds
active or non-renewing status. Once set, the value can't be changed. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
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>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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=33
optional, string, max chars=33
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, string, max chars=33
optional, string, max chars=33
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
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.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean, default=true
optional, boolean, default=true
Returns
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Create quote for updating a subscription¶
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
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
Notes specific to this quote that you want customers to see on the quote PDF.
optional, string, max chars=2000
optional, string, max chars=2000
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Should be true if the existing addons should be replaced with the ones that are being passed.
optional, boolean, default=false
optional, boolean, default=false
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
optional, integer, min=0
optional, integer, min=0
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
optional, integer, min=1
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, integer, min=1
When the subscription is reactivated as described under the
optional, timestamp(UTC) in seconds
reactivate parameter, this is the date/time at which the subscription should be reactivated.optional, timestamp(UTC) in seconds
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
optional, enumerated string
optional, enumerated string
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.
Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string
optional, list of string
Should be true if the existing coupons should be replaced with the ones that are being passed.
optional, boolean, default=false
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.
optional, boolean, default=false
optional, boolean, default=false
Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
optional, boolean
optional, boolean
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
required, string, max chars=50
required, string, max chars=50
Represents the plan quantity for this subscription.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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=33
optional, string, max chars=33
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, string, max chars=33
optional, string, max chars=33
The new start date of a
optional, timestamp(UTC) in seconds
future subscription. Applicable only for future subscriptions.optional, timestamp(UTC) in seconds
End of the trial period for the subscription. This overrides the trial period set for the plan.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
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.
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
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=20
optional, string, max chars=20
Confirms that a customer is registered under GST. If set to
optional, boolean
true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.optional, boolean
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=renew
Contract 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 .
optional, enumerated string, default=renew
Possible values are
renewcontract_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.
The number of days before
optional, integer
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.optional, integer
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>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
Amount that will override the Addon's default price. The unit depends on the type of currency. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, 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.
optional, integer, min=1
optional, integer, min=1
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=33
optional, string, max chars=33
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
optional, string, max chars=33
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, string, max chars=33
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
optional, timestamp(UTC) in seconds
replace_addon_list. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
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>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Indicates when the non-recurring addon will be charged.
optional, enumerated string
optional, enumerated string
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.
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
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.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean, default=true
optional, boolean, default=true
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=33
optional, string, max chars=33
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.
optional, string, max chars=33
optional, string, max chars=33
Returns
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Edit quote for updating a subscription¶
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[id]="__test__KyVnJjRnFYaT75pr" \
-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
curl https://{site}.chargebee.com/api/v2/quotes/1/edit_update_subscription_quote \
-u {site_api_key}:\
-d subscription[id]="__test__KyVnJjRnFYaT75pr" \
-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
Notes specific to this quote that you want customers to see on the quote PDF.
optional, string, max chars=2000
optional, string, max chars=2000
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Should be true if the existing addons should be replaced with the ones that are being passed.
optional, boolean, default=false
optional, boolean, default=false
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, list of string
optional, list of string
The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
optional, integer, min=0
optional, integer, min=0
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
optional, integer, min=1
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, integer, min=1
When the subscription is reactivated as described under the
optional, timestamp(UTC) in seconds
reactivate parameter, this is the date/time at which the subscription should be reactivated.optional, timestamp(UTC) in seconds
Override the billing alignment mode chosen for the site for calendar billing. Only applicable when using calendar billing.
optional, enumerated string
optional, enumerated string
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.
Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, list of string
optional, list of string
Should be true if the existing coupons should be replaced with the ones that are being passed.
optional, boolean, default=false
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.
optional, boolean, default=false
optional, boolean, default=false
Applicable only for cancelled subscriptions. Once this is passed as true, cancelled subscription will become active; otherwise subscription changes will be made but the the subscription state will remain cancelled. If not passed, subscription will be activated only if there is any change in subscription data.
optional, boolean
optional, boolean
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
Represents the plan quantity for this subscription.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
Amount that will override the Plan's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
Amount that will override the default setup fee. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
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=33
optional, string, max chars=33
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, string, max chars=33
optional, string, max chars=33
The new start date of a
optional, timestamp(UTC) in seconds
future subscription. Applicable only for future subscriptions.optional, timestamp(UTC) in seconds
End of the trial period for the subscription. This overrides the trial period set for the plan.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
Defines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.
optional, enumerated string
optional, enumerated string
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.
The preferred offline payment method for the subscription.
optional, enumerated string
optional, enumerated string
Possible values are
no_preferenceNo Preference.cashCash.checkCheck.bank_transferBank Transfer.ach_creditACH Credit.sepa_creditSEPA Credit.
Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as
optional, integer, min=1, max=100
billing_cycles or a custom value depending on the site configuration.optional, integer, min=1, max=100
Parameters for billing_address
pass parameters as billing_address[<param name>]
pass parameters as billing_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
Parameters for customer
pass parameters as customer[<param name>]
pass parameters as customer[<param name>]
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=20
optional, string, max chars=20
Confirms that a customer is registered under GST. If set to
optional, boolean
true then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured for your site.optional, boolean
Parameters for contract_term
pass parameters as contract_term[<param name>]
pass parameters as contract_term[<param name>]
Action to be taken when the contract term completes.
optional, enumerated string, default=renew
Contract 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 .
optional, enumerated string, default=renew
Possible values are
renewcontract_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.
The number of days before
optional, integer
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.optional, integer
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>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
Amount that will override the Addon's default price. The unit depends on the type of currency. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, 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.
optional, integer, min=1
optional, integer, min=1
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=33
optional, string, max chars=33
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
optional, string, max chars=33
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, string, max chars=33
The time at which the trial ends for the addon. To update this value, redo the complete addon set using
optional, timestamp(UTC) in seconds
replace_addon_list. (Addon trial periods must be enabled by Chargebee Support.).optional, timestamp(UTC) in seconds
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>]
A unique 'id' used to identify the addon.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=0
optional, integer, min=0
Amount that will override the Addon's default price. The unit depends on the type of currency.
optional, in cents, min=0
optional, in cents, min=0
Defines service period of the addon in days from the day of charge.
optional, integer, min=1, max=730
optional, integer, min=1, max=730
Indicates when the non-recurring addon will be charged.
optional, enumerated string
optional, enumerated string
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.
Event on which this addon will be charged.
optional, enumerated string
optional, enumerated string
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.
If enabled, the addon will be charged only at the first occurrence of the event. Applicable only for non-recurring add-ons.
optional, boolean, default=true
optional, boolean, default=true
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=33
optional, string, max chars=33
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.
optional, string, max chars=33
optional, string, max chars=33
Returns
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Create quote for one-time charges¶
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
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
Identifier of the customer for which the quote needs to be created.
required, string, max chars=50
required, string, max chars=50
Notes specific to this quote that you want customers to see on the quote PDF.
optional, string, max chars=2000
optional, string, max chars=2000
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The currency code (ISO 4217 format) of the quote.
required if Multicurrency is enabled, string, max chars=3
required if Multicurrency is enabled, string, max chars=3
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
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>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Amount that will override the Addon's default price. The unit depends on the type of currency. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
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.
optional, string, max chars=33
optional, string, max chars=33
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>]
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, enumerated string
optional, enumerated string
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumer.retailTransaction is a sale to an end user.consumedTransaction is for an item that is consumed directly.vendor_useTransaction is for an item that is subject to vendor use tax.
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, integer
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.
optional, integer
optional, integer
Returns
Resource object representing quote.
always returned
always returned
Edit quote for one-time charges¶
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 \
-u {site_api_key}:\
-d charges[amount][0]=1000 \
-d charges[description][0]="Service Charge"
copy
curl https://{site}.chargebee.com/api/v2/quotes/6/edit_one_time_quote \
-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
Notes specific to this quote that you want customers to see on the quote PDF.
optional, string, max chars=2000
optional, string, max chars=2000
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, timestamp(UTC) in seconds
optional, timestamp(UTC) in seconds
The currency code (ISO 4217 format) of the quote.
required if Multicurrency is enabled, string, max chars=3
required if Multicurrency is enabled, string, max chars=3
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
pass parameters as shipping_address[<param name>]
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set
optional, string, max chars=50
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
optional, string, max chars=50
state_code is provided.optional, string, max chars=50
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>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
optional, integer, default=1, min=1
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
optional, string, max chars=33
optional, string, max chars=33
Amount that will override the Addon's default price. The unit depends on the type of currency. The Plan's billing frequency will not be considered for overriding. E.g. If the Plan's billing frequency is every 3 months, and if the price override amount is $10, $10 will be used, and not $30 (i.e $10*3).
optional, in cents, min=0
optional, in cents, min=0
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.
optional, string, max chars=33
optional, string, max chars=33
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>]
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, enumerated string
optional, enumerated string
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumer.retailTransaction is a sale to an end user.consumedTransaction is for an item that is consumed directly.vendor_useTransaction is for an item that is subject to vendor use tax.
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, integer
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.
optional, integer
optional, integer
Returns
Resource object representing quote.
always returned
always returned
List 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
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
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set
optional, string, max chars=1000
offset to the value of next_offset obtained in the previous iteration of the API call.optional, string, max chars=1000
If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted' attribute will be 'true'.
optional, boolean, default=false
optional, boolean, default=false
Sorts based on the specified attribute.
Supported attributes : date
Supported sort-orders : asc, desc
Example → sort_by[asc] = "date"
This will sort the result based on the 'date' attribute in ascending(earliest first) order.
optional, string filter
Supported attributes : date
Supported sort-orders : asc, desc
Example → sort_by[asc] = "date"
This will sort the result based on the 'date' attribute in ascending(earliest first) order.
optional, string filter
Filter Params
For operator usages, see the Pagination and Filtering section.
The quote number. Acts as a identifier for quote and typically generated sequentially.
Supported operators : is, is_not, starts_with, in, not_in
Example → id[is_not] = "123"
optional, string filter
Supported operators : is, is_not, starts_with, in, not_in
Example → id[is_not] = "123"
optional, string filter
The identifier of the customer this quote belongs to.
Supported operators : is, is_not, starts_with, in, not_in
Example → customer_id[is] = "4gmiXbsjdm"
optional, string filter
Supported operators : is, is_not, starts_with, in, not_in
Example → customer_id[is] = "4gmiXbsjdm"
optional, string filter
To filter based on subscription_id. NOTE: Not to be used if consolidated invoicing feature is enabled.
Supported operators : is, is_not, starts_with, is_present, in, not_in
Example → subscription_id[is_not] = "4gmiXbsjdm"
optional, string filter
Supported operators : is, is_not, starts_with, is_present, in, not_in
Example → subscription_id[is_not] = "4gmiXbsjdm"
optional, string filter
Current status of this quote. Possible values are : open, accepted, declined, invoiced, closed.
Supported operators : is, is_not, in, not_in
Example → status[is] = "open"
optional, enumerated string filter
Supported operators : is, is_not, in, not_in
Example → status[is] = "open"
optional, enumerated string filter
Creation date of the quote. Typically this is the date on which quote is generated.
Supported operators : after, before, on, between
Example → date[on] = "1435054328"
optional, timestamp(UTC) in seconds filter
Supported operators : after, before, on, between
Example → date[on] = "1435054328"
optional, timestamp(UTC) in seconds filter
Returns
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
next_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”.
optional, string, max chars=1000
optional, string, max chars=1000
List quote line groups¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/9/quote_line_groups \
-G \
-u {site_api_key}:
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
Resource object representing quote_line_group.
always returned
always returned
next_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”.
optional, string, max chars=1000
optional, string, max chars=1000
Convert a quote¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/1/convert \
-X POST \
-u {site_api_key}:
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
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.
optional, boolean
optional, boolean
Parameters for subscription
pass parameters as subscription[<param name>]
pass parameters as subscription[<param name>]
Applicable only for create subscription quote.
optional, enumerated string
optional, enumerated string
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
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Resource object representing customer.
always returned
always returned
Resource object representing subscription.
optional
optional
Resource object representing invoice.
optional
optional
Resource object representing credit_note.
optional
optional
Resource object representing unbilled_charge.
optional
optional
Update quote status¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/11/update_status \
-X POST \
-u {site_api_key}:\
-d status="accepted"
copy
curl https://{site}.chargebee.com/api/v2/quotes/11/update_status \
-X POST \
-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
Status to update for the quote.
required, enumerated string
required, enumerated string
Possible values are
acceptedAccepted.declinedDeclined.closedClosed.
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.
optional, string, max chars=300
optional, string, max chars=300
Returns
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Extend expiry date¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/10/extend_expiry_date \
-X POST \
-u {site_api_key}:\
-d valid_till=1581791399
copy
curl https://{site}.chargebee.com/api/v2/quotes/10/extend_expiry_date \
-X POST \
-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
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Delete a quote¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/5/delete \
-X POST \
-u {site_api_key}:
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
Resource object representing quote.
always returned
always returned
Resource object representing quoted_subscription.
optional
optional
Retrieve Quote as PDF¶
Sample Request
curl https://{site}.chargebee.com/api/v2/quotes/9/pdf \
-X POST \
-u {site_api_key}:
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
When true, the quote PDF has summary of all charges on the quote. When false, the quote PDF has a detailed view of charges grouped by charge event. This parameter does not affect one-time quotes.
optional, boolean, default=false
optional, boolean, default=false
Returns
Resource object representing download.
always returned
always returned