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
string, max chars=50
The quote number. Acts as a identifier for quote and typically generated sequentially.
optional, string, max chars=100
The quote name will be used as the pdf name of the quote.
optional, string, max chars=100
Purchase Order Number
string, max chars=50
The identifier of the customer this quote belongs to.
optional, string, max chars=50
The identifier of the subscription this quote belongs to.
optional, string, max chars=50
The identifier of the invoice generated while converting this quote.
enumerated stringCurrent status of this quote.
Possible values are
openOpen.acceptedAccepted.declinedDeclined.invoicedInvoiced.closedClosed.
enumerated stringOperation Type
Possible values are
create_subscription_for_customercreate_subscription_for_customer.change_subscriptionchange_subscription.onetime_invoiceonetime_invoice.
optional, string, max chars=20VAT/ Tax registration number of the customer.
Learn more
enumerated string, default=tax_exclusiveThe price type of the quote.
Possible values are
tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.
timestamp(UTC) in seconds
Quote will be valid till this date. After this date quote will be marked as closed.
timestamp(UTC) in seconds
Creation date of the quote. Typically this is the date on which quote is generated.
optional, in cents, min=0
Total contract value. Applicable when multi billing cycle quote is enabled.
optional, in cents, default=0, min=0
Charge on acceptance. Applicable when multi billing cycle quote is enabled.
in cents, min=0
Subtotal (in cents) of the first quote line group.
optional, in cents, default=0, min=0
Total (in cents) of the first quote line group.
optional, in cents, default=0, min=0
Credits applied (in cents) for the first quote line group.
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
Amount due (in cents) for the first quote line group.
optional, integer, default=1
Version of the quote.
optional, long
Version number of this resource. The resource_version
is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
optional, timestamp(UTC) in seconds
Timestamp indicating when this quote was last updated.
optional, string, max chars=10An 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.
string, max chars=3
The currency code (ISO 4217 format) of the quote.
optional, jsonarray
List of notes associated with this quotes.
optional, timestamp(UTC) in seconds
Specifies the contract term’s start date.
optional, timestamp(UTC) in seconds
Specifies the contract term’s end date. It indicates when the action set in action_at_term_end
gets triggered.
contract_term_termination_fee
optional, in cents, min=0
Specifies the charge to be applied for terminating the contract term.
string, max chars=50The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
optional, list of line_item
The list of line items for this quote.
optional, string, max chars=40
Uniquely identifies a line_item
optional, string, max chars=50
A unique identifier for the subscription this line item belongs to.
timestamp(UTC) in seconds
Start date of this line item.
timestamp(UTC) in seconds
End date of this line item.
in cents
Unit amount of the line item.
optional, in cents
Total amount of this line item. Typically equals to unit amount x quantity
optional, enumerated stringThe
pricing scheme for this item.
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.
boolean, default=false
Specifies whether this line item is taxed or not
optional, in cents, default=0, min=0
The tax amount charged for this item
optional, double, min=0.0, max=100.0
Rate of tax used to calculate tax for this lineitem
optional, string, max chars=39The decimal representation of the unit amount of the
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=33The decimal representation of the quantity of this line_item. Returned when the
line_item
is quantity-based and
multi-decimal pricing is enabled.
optional, string, max chars=39The decimal representation of the amount for the
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, in cents, min=0
Total discounts for this line
item_level_discount_amount
optional, in cents, min=0
Line Item-level discounts for this line.
optional, string, max chars=40
Invoice Reference Line Item ID
string, max chars=250
Detailed description about this line item.
optional, string, max chars=500
Detailed description about this item.
enumerated stringSpecifies the modelled entity this line item is based on.
Possible values are
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan idplanIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan idaddonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon idadhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
optional, enumerated stringThe reason due to which the line item price/amount is exempted from tax.
Possible values are
tax_not_configuredIf tax is not enabled for the siteregion_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 jurisdictionexportYou 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 respectivelycustomer_exemptIf the Customer is marked as Tax exemptproduct_exemptIf the Plan or Addon is marked as Tax exemptzero_ratedIf the rate of tax is 0% and no Sales/ GST tax is collectable for that line itemreverse_chargeIf the Customer is identified as B2B customer (when VAT Number is entered), applicable for EU onlyhigh_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 appliedzero_value_itemIf the total invoice value/amount is equal to zero. E.g., If the total order value is $10 and a $10 coupon has been applied against that order, the total order value becomes $0. Hence the invoice value also becomes $0.
Show all values[+]
optional, string, max chars=100
The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type
optional, string, max chars=100
A unique identifier for the customer this line item belongs to
optional, list of discount
The list of all deductions applied to the quote.
in cents, min=0The amount deducted. The format of this value depends on the
kind of currency.
optional, string, max chars=250
Description for this deduction.
optional, string, max chars=40
The unique id of the line item that this deduction is for. Is required when discounts[entity_type]
is item_level_coupon
or document_level_coupon
.
enumerated stringThe type of deduction and the amount to which it is applied.
Possible values are
item_level_couponThe deduction is due to a coupon applied to line item. The coupon id
is passed as entity_id
.document_level_couponThe deduction is due to a coupon applied to the invoice sub_total
. The coupon id is passed as entity_id
.promotional_creditsThe deduction is due to a promotional credit applied to the invoice. prorated_creditsThe deduction is due to a legacy adjustment credit applied to the invoice. The entity_id
is null
in this case. The legacy credits feature is superseded by adjustment_credit_notes
.
optional, string, max chars=100
When the deduction is due to a coupon
, then this is the id
of the coupon.
optional, string, max chars=50The
coupon code, if applicable, used to provide the discount. The
coupon.id is available in
entity_id
.
optional, list of line_item_discount
The list of deductions applied for each line item of this quote.
Line item discount attributes
string, max chars=50
The unique id of the line item that this deduction is for.
enumerated stringThe type of deduction and the amount to which it is applied.
Possible values are
item_level_couponThe deduction is due to a coupon applied to a line item of the invoice. The coupon id
is available as entity_id
.document_level_couponThe deduction is due to a coupon applied to the invoice sub_total
. The coupon id
is available as entity_id
.promotional_creditsThe deduction is due to a promotional credit applied to the invoice. The entity_id
is null
in this case.prorated_creditsThe deduction is due to a legacy adjustment credit applied to the invoice. The entity_id
is null
in this case. The legacy credits feature is superseded by adjustment_credit_notes
.
optional, string, max chars=50
When the deduction is due to a coupon, then this is the id of the coupon.
in cents, min=0The amount deducted. The format of this value depends on the
kind of currency.
optional, list of tax
The list of taxes applicable for this quote.
string, max chars=100
The name of the tax applied. E.g. GST.
in cents, min=0
The tax amount.
optional, string, max chars=250
Description of the tax item.
optional, list of line_item_tax
The list of taxes applied on the line items of this quote.
optional, string, max chars=40
The unique reference id of the line item for which the tax is applicable
string, max chars=100
The name of the tax applied
double, default=0.0, min=0.0, max=100.0
The rate of tax used to calculate tax amount
optional, boolean
Indicates if tax is applied only on a portion of the line item amount.
optional, boolean
Indicates the non-compliance tax that should not be reported to the jurisdiction.
in cents, min=0
Indicates the actual portion of the line item amount that is taxable.
in cents, min=0
The tax amount
optional, enumerated stringThe type of tax jurisdiction
Possible values are
countryThe tax jurisdiction is a countryfederalThe tax jurisdiction is a federalstateThe tax jurisdiction is a statecountyThe tax jurisdiction is a countycityThe tax jurisdiction is a cityspecialSpecial tax jurisdiction.unincorporatedCombined tax of state and county.otherJurisdictions other than the ones listed above.
optional, string, max chars=250
The name of the tax jurisdiction
optional, string, max chars=250
The tax jurisdiction code
tax_amount_in_local_currency
optional, in cents, min=0
Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
optional, string, max chars=3
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
optional, list of line_item_tier
The list of tiers applicable for the various line items in this quote.
Line item tier attributes
optional, string, max chars=40
Uniquely identifies a line_item
integer, min=0
The lower limit of a range of units for the tier
optional, integer
The upper limit of a range of units for the tier
integer, min=0
The number of units purchased in a range.
in cents, min=0
The price of the tier if the charge model is a stairtstep
pricing , or the price of each unit in the tier if the charge model is tiered
/volume
pricing.
optional, string, max chars=33The 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
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=33The 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
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=33The decimal representation of the quantity purchased from this tier. Returned when the
line_item
is quantity-based and
multi-decimal pricing is enabled.
optional, string, max chars=40The decimal representation of the per-unit price for the tier when the
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, shipping_address
Shipping address for the quote.
Shipping address attributes
optional, string, max chars=150
The first name of the contact.
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
optional, string, max chars=50The
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.
optional, string, max chars=50The 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, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
optional, enumerated string, default=not_validatedThe 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.
integer, min=0
The index number of the subscription to which the item price is added. Provide a unique number between 0
and 4
(inclusive) for each subscription that is to be created.
optional, billing_address
Billing address for the quote.
Billing address attributes
optional, string, max chars=150
The first name of the billing contact.
optional, string, max chars=150
The last name of the billing contact.
optional, string, max chars=70
The email address.
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
optional, string, max chars=50The
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
State or Province
optional, string, max chars=50The 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, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
optional, enumerated string, default=not_validatedThe 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.
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
curl https://{site}.chargebee.com/api/v2/quotes/10 \
-u {site_api_key}:
Sample Response [ JSON ]
Show more...
{"quote": {
"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
}}
URL Format GET
https://{site}.chargebee.com/api/v2/quotes/{quote_id}
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
optional
Resource object representing quoted_charge
Sample admin console URL
https://{site}.chargebee.com/admin-console/quotes/123x
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 ]
Show more...
{
"quote": {
"amount_due": 1000,
"amount_paid": 0,
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"object": "billing_address",
"validation_status": "not_validated"
},
"charge_on_acceptance": 0,
"credits_applied": 0,
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWTLzbAo",
"date": 1517501496,
"id": "2",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 1000,
"customer_id": "__test__KyVnHhSBWTLzbAo",
"date_from": 1517501496,
"date_to": 1519920696,
"description": "Basic",
"discount_amount": 0,
"entity_id": "basic",
"entity_type": "plan",
"id": "__test__KyVnHhSBWTM2nAy",
"is_taxed": false,
"item_level_discount_amount": 0,
"object": "line_item",
"pricing_model": "per_unit",
"quantity": 1,
"tax_amount": 0,
"unit_amount": 1000
},
{..}
],
"object": "quote",
"operation_type": "create_subscription_for_customer",
"price_type": "tax_exclusive",
"resource_version": 1517501496000,
"status": "open",
"sub_total": 1000,
"taxes": [],
"total": 1000,
"updated_at": 1517501496,
"valid_till": 1517596199,
"version": 1
},
"quoted_subscription": {
"object": "quoted_subscription",
"plan_id": "basic",
"plan_quantity": 1
}
}
URL Format POST
https://{site}.chargebee.com/api/v2/customers/{customer_id}/create_subscription_quote
optional, string, max chars=100
The quote name will be used as the pdf name of the quote.
optional, string, max chars=2000
Notes specific to this quote that you want customers to see on the quote PDF.
optional, timestamp(UTC) in seconds
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, integer, min=0
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
mandatory_addons_to_remove[0..n]
optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, integer, min=1The number of subscription billing cycles (including the first one) to
invoice in advance.
optional, enumerated stringOverride 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.
optional, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.
Parameters for subscription
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.
optional, string, max chars=100
Purchase order number for this subscription.
required, string, max chars=100
Identifier of the plan for this subscription
subscription[plan_quantity]
optional, integer, default=1, min=1
Plan quantity for this subscription
subscription[plan_quantity_in_decimal]
optional, string, max chars=33The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when
multi-decimal pricing is enabled.
subscription[plan_unit_price]
optional, in cents, min=0Amount that will override the Plan's default price. The unit depends on the
type of currency.
subscription[plan_unit_price_in_decimal]
optional, string, max chars=39When
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=0Amount 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.
optional, timestamp(UTC) in secondsThe 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.
subscription[offline_payment_method]
optional, enumerated stringThe preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA Credit
subscription[contract_term_billing_cycle_on_renewal]
optional, integer, min=1, max=100Number 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>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
shipping_address[country]
optional, string, max chars=50The 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.
shipping_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
contract_term[action_at_term_end]
optional, enumerated string, default=cancelAction 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 contract_billing_cycle_on_renewal
.The action_at_term_end
for the new contract term is set to renew
.evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
contract_term[cancellation_cutoff_period]
optional, integer, default=0The 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>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
addons[quantity_in_decimal][0..n]
optional, string, max chars=33The 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=0The 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_price
provided 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.
addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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.
addons[billing_cycles][0..n]
optional, integer, min=1
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 secondsThe 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>]
event_based_addons[id][0..n]
optional, string, max chars=100
A unique 'id' used to identify the addon.
event_based_addons[quantity][0..n]
optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
event_based_addons[unit_price][0..n]
optional, in cents, min=0Amount that will override the Addon's default price. The unit depends on the
type of currency.
event_based_addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when
multi-decimal pricing is enabled.
event_based_addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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.
event_based_addons[service_period_in_days][0..n]
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
event_based_addons[on_event][0..n]
optional, enumerated stringEvent 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.
event_based_addons[charge_once][0..n]
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.
event_based_addons[charge_on][0..n]
optional, enumerated stringIndicates 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.
always returned
Resource object representing quote
optional
Resource object representing quoted_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 ]
Show more...
{"quote": {
"id": "5",
"customer_id": "__dev__KyVlEuRpeT0m25",
"status": "open",
"operation_type": "create_subscription_for_customer",
"price_type": "tax_exclusive",
"valid_till": 1581791399,
"date": 1580927607,
"total_payable": 1395,
"charge_on_acceptance": 1395,
"sub_total": 1395,
"total": 1395,
"credits_applied": 0,
"amount_paid": 0,
"amount_due": 1395,
"updated_at": 1580927607,
"resource_version": 1580927607468,
"object": "quote",
"line_items": [
{
"id": "__dev__KyVl9ORpeV7yI7",
"date_from": 1580927606,
"date_to": 1583433206,
"unit_amount": 900,
"quantity": 1,
"amount": 900,
"pricing_model": "per_unit",
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"customer_id": "__dev__KyVlEuRpeT0m25",
"description": "No Trial",
"entity_type": "plan",
"entity_id": "no-trial",
"discount_amount": 0,
"item_level_discount_amount": 0
},
{..}
],
"line_item_discounts": [],
"taxes": [],
"line_item_taxes": [],
"currency_code": "USD"
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/edit_create_subscription_quote
optional, string, max chars=2000
Notes specific to this quote that you want customers to see on the quote PDF.
optional, timestamp(UTC) in seconds
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, integer, min=0
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
mandatory_addons_to_remove[0..n]
optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, integer, min=1The number of subscription billing cycles (including the first one) to
invoice in advance.
optional, enumerated stringOverride 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.
optional, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.
Parameters for subscription
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.
required, string, max chars=100
Identifier of the plan for this subscription
subscription[plan_quantity]
optional, integer, default=1, min=1
Plan quantity for this subscription
subscription[plan_quantity_in_decimal]
optional, string, max chars=33The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when
multi-decimal pricing is enabled.
subscription[plan_unit_price]
optional, in cents, min=0Amount that will override the Plan's default price. The unit depends on the
type of currency.
subscription[plan_unit_price_in_decimal]
optional, string, max chars=39When
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=0Amount 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.
optional, timestamp(UTC) in secondsThe 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.
subscription[offline_payment_method]
optional, enumerated stringThe preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA Credit
subscription[contract_term_billing_cycle_on_renewal]
optional, integer, min=1, max=100Number 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>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
shipping_address[country]
optional, string, max chars=50The 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.
shipping_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
contract_term[action_at_term_end]
optional, enumerated string, default=cancelAction 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 contract_billing_cycle_on_renewal
.The action_at_term_end
for the new contract term is set to renew
.evergreenContract term completes and the subscription renews.cancelContract term completes and subscription is canceled.
contract_term[cancellation_cutoff_period]
optional, integer, default=0The 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>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
addons[quantity_in_decimal][0..n]
optional, string, max chars=33The 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=0The 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_price
provided 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.
addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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.
addons[billing_cycles][0..n]
optional, integer, min=1
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 secondsThe 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>]
event_based_addons[id][0..n]
optional, string, max chars=100
A unique 'id' used to identify the addon.
event_based_addons[quantity][0..n]
optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
event_based_addons[unit_price][0..n]
optional, in cents, min=0Amount that will override the Addon's default price. The unit depends on the
type of currency.
event_based_addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when
multi-decimal pricing is enabled.
event_based_addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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.
event_based_addons[service_period_in_days][0..n]
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
event_based_addons[on_event][0..n]
optional, enumerated stringEvent 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.
event_based_addons[charge_once][0..n]
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.
event_based_addons[charge_on][0..n]
optional, enumerated stringIndicates 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.
always returned
Resource object representing quote
optional
Resource object representing quoted_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 ]
Show more...
{
"quote": {
"amount_due": 895,
"amount_paid": 0,
"billing_address": {
"city": "Walnut",
"country": "US",
"first_name": "John",
"last_name": "Doe",
"line1": "PO Box 9999",
"object": "billing_address",
"state": "California",
"validation_status": "not_validated",
"zip": "91789"
},
"charge_on_acceptance": 0,
"credits_applied": 0,
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWTMBNBB",
"date": 1517501497,
"id": "4",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 895,
"customer_id": "__test__KyVnHhSBWTMBNBB",
"date_from": 1517501497,
"date_to": 1519920697,
"description": "No Trial - Prorated Charges",
"discount_amount": 0,
"entity_id": "no_trial",
"entity_type": "plan",
"id": "__test__KyVnHhSBWTMHrBN",
"is_taxed": false,
"item_level_discount_amount": 0,
"object": "line_item",
"pricing_model": "per_unit",
"quantity": 1,
"tax_amount": 0,
"unit_amount": 895
},
{..}
],
"object": "quote",
"operation_type": "change_subscription",
"price_type": "tax_exclusive",
"resource_version": 1517501497000,
"status": "open",
"sub_total": 895,
"subscription_id": "__test__KyVnHhSBWTMBNBB",
"taxes": [],
"total": 895,
"updated_at": 1517501497,
"valid_till": 1517596199,
"version": 1
},
"quoted_subscription": {
"id": "__test__KyVnHhSBWTMBNBB",
"object": "quoted_subscription",
"plan_id": "no_trial",
"plan_quantity": 1
}
}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/update_subscription_quote
optional, string, max chars=100
The quote name will be used as the pdf name of the quote.
optional, string, max chars=2000
Notes specific to this quote that you want customers to see on the quote PDF.
optional, timestamp(UTC) in seconds
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, boolean, default=false
Should be true if the existing addons should be replaced with the ones that are being passed.
mandatory_addons_to_remove[0..n]
optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, integer, min=0
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=1The 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 secondsIf 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_at
cannot be earlier than 14th February.
.
optional, enumerated stringOverride 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, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, boolean, default=false
Should be true if the existing coupons should be replaced with the ones that are being passed.
optional, enumerated stringWhen 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 secondsWhen
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
status
is active
, cancelled
, or non_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_at
cannot 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.
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.
Parameters for subscription
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.
optional, string, max chars=100
Identifier of the plan for this subscription
subscription[plan_quantity]
optional, integer, default=1, min=1
Represents the plan quantity for this subscription.
subscription[plan_unit_price]
optional, in cents, min=0Amount that will override the Plan's default price. The unit depends on the
type of currency.
optional, in cents, min=0Amount that will override the default setup fee. The unit depends on the
type of currency.
subscription[plan_quantity_in_decimal]
optional, string, max chars=33The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when
multi-decimal pricing is enabled.
subscription[plan_unit_price_in_decimal]
optional, string, max chars=39When 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 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 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.
subscription[auto_collection]
optional, enumerated stringDefines 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.
subscription[offline_payment_method]
optional, enumerated stringThe preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA Credit
subscription[contract_term_billing_cycle_on_renewal]
optional, integer, min=1, max=100Number 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>]
billing_address[first_name]
optional, string, max chars=150
The first name of the billing contact.
billing_address[last_name]
optional, string, max chars=150
The last name of the billing contact.
optional, string, max chars=70
The email address.
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
billing_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
optional, string, max chars=50The 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.
billing_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
shipping_address[country]
optional, string, max chars=50The 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.
shipping_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
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.
customer[vat_number_prefix]
optional, string, max chars=10An 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.
customer[registered_for_gst]
optional, booleanConfirms 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>]
contract_term[action_at_term_end]
optional, enumerated string, default=renewAction 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 contract_billing_cycle_on_renewal
.The action_at_term_end
for the new contract term is set to renew
.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 contract_billing_cycle_on_renewal
.The action_at_term_end
for the new contract term is set to cancel
.
contract_term[cancellation_cutoff_period]
optional, integerThe 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>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
optional, in cents, min=0The 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_price
provided 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.
addons[billing_cycles][0..n]
optional, integer, min=1
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.
addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when
multi-decimal pricing is enabled.
addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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 secondsThe 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>]
event_based_addons[id][0..n]
optional, string, max chars=100
A unique 'id' used to identify the addon.
event_based_addons[quantity][0..n]
optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
event_based_addons[unit_price][0..n]
optional, in cents, min=0Amount that will override the Addon's default price. The unit depends on the
type of currency.
event_based_addons[service_period_in_days][0..n]
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
event_based_addons[charge_on][0..n]
optional, enumerated stringIndicates 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.
event_based_addons[on_event][0..n]
optional, enumerated stringEvent 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.
event_based_addons[charge_once][0..n]
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.
event_based_addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when
multi-decimal pricing is enabled.
event_based_addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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.
always returned
Resource object representing quote
optional
Resource object representing quoted_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 ]
Show more...
{"quote": {
"id": "5",
"customer_id": "__dev__KyVlEuRpeT0m25",
"status": "open",
"operation_type": "change_subscription",
"price_type": "tax_exclusive",
"valid_till": 1581791399,
"date": 1580927607,
"total_payable": 1395,
"charge_on_acceptance": 1395,
"sub_total": 1395,
"total": 1395,
"credits_applied": 0,
"amount_paid": 0,
"amount_due": 1395,
"updated_at": 1580927607,
"resource_version": 1580927607468,
"object": "quote",
"line_items": [
{
"id": "__dev__KyVl9ORpeV7yI7",
"date_from": 1580927606,
"date_to": 1583433206,
"unit_amount": 900,
"quantity": 1,
"amount": 900,
"pricing_model": "per_unit",
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"customer_id": "__dev__KyVlEuRpeT0m25",
"description": "No Trial",
"entity_type": "plan",
"entity_id": "no-trial",
"discount_amount": 0,
"item_level_discount_amount": 0
},
{..}
],
"line_item_discounts": [],
"taxes": [],
"line_item_taxes": [],
"currency_code": "USD"
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/edit_update_subscription_quote
optional, string, max chars=2000
Notes specific to this quote that you want customers to see on the quote PDF.
optional, timestamp(UTC) in seconds
Quotes will be vaild till this date. After this quote will be marked as closed.
optional, boolean, default=false
Should be true if the existing addons should be replaced with the ones that are being passed.
mandatory_addons_to_remove[0..n]
optional, list of string
List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
optional, integer, min=0
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=1The 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 secondsIf 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_at
cannot be earlier than 14th February.
.
optional, enumerated stringOverride 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, list of string
Identifier of the coupon as a List. Coupon Codes can also be passed.
optional, boolean, default=false
Should be true if the existing coupons should be replaced with the ones that are being passed.
optional, enumerated stringWhen 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 secondsWhen
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
status
is active
, cancelled
, or non_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_at
cannot 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.
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.
Parameters for subscription
pass parameters as subscription[<param name>]
optional, string, max chars=100
Identifier of the plan for this subscription
subscription[plan_quantity]
optional, integer, default=1, min=1
Represents the plan quantity for this subscription.
subscription[plan_unit_price]
optional, in cents, min=0Amount that will override the Plan's default price. The unit depends on the
type of currency.
optional, in cents, min=0Amount that will override the default setup fee. The unit depends on the
type of currency.
subscription[plan_quantity_in_decimal]
optional, string, max chars=33The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when
multi-decimal pricing is enabled.
subscription[plan_unit_price_in_decimal]
optional, string, max chars=39When 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 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 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.
subscription[auto_collection]
optional, enumerated stringDefines 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.
subscription[offline_payment_method]
optional, enumerated stringThe preferred offline payment method for the subscription.
Possible values are
no_preferenceNo PreferencecashCashcheckCheckbank_transferBank Transferach_creditACH Creditsepa_creditSEPA Credit
subscription[contract_term_billing_cycle_on_renewal]
optional, integer, min=1, max=100Number 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>]
billing_address[first_name]
optional, string, max chars=150
The first name of the billing contact.
billing_address[last_name]
optional, string, max chars=150
The last name of the billing contact.
optional, string, max chars=70
The email address.
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
billing_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
optional, string, max chars=50The 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.
billing_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
shipping_address[country]
optional, string, max chars=50The 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.
shipping_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
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.
customer[vat_number_prefix]
optional, string, max chars=10An 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.
customer[registered_for_gst]
optional, booleanConfirms 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>]
contract_term[action_at_term_end]
optional, enumerated string, default=renewAction 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 contract_billing_cycle_on_renewal
.The action_at_term_end
for the new contract term is set to renew
.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 contract_billing_cycle_on_renewal
.The action_at_term_end
for the new contract term is set to cancel
.
contract_term[cancellation_cutoff_period]
optional, integerThe 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>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
optional, in cents, min=0The 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_price
provided 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.
addons[billing_cycles][0..n]
optional, integer, min=1
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.
addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when
multi-decimal pricing is enabled.
addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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 secondsThe 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>]
event_based_addons[id][0..n]
optional, string, max chars=100
A unique 'id' used to identify the addon.
event_based_addons[quantity][0..n]
optional, integer, min=0
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
event_based_addons[unit_price][0..n]
optional, in cents, min=0Amount that will override the Addon's default price. The unit depends on the
type of currency.
event_based_addons[service_period_in_days][0..n]
optional, integer, min=1, max=730
Defines service period of the addon in days from the day of charge.
event_based_addons[charge_on][0..n]
optional, enumerated stringIndicates 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.
event_based_addons[on_event][0..n]
optional, enumerated stringEvent 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.
event_based_addons[charge_once][0..n]
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.
event_based_addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Can be provided for quantity-based addons and only when
multi-decimal pricing is enabled.
event_based_addons[unit_price_in_decimal][0..n]
optional, string, max chars=39When
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.
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
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 ]
Show more...
{"quote": {
"amount_due": 1000,
"amount_paid": 0,
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"object": "billing_address",
"validation_status": "not_validated"
},
"charge_on_acceptance": 1000,
"credits_applied": 0,
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWTM5WB0",
"date": 1517501496,
"id": "3",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 1000,
"customer_id": "__test__KyVnHhSBWTM5WB0",
"date_from": 1517501496,
"date_to": 1517501496,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTM8HB9",
"is_taxed": false,
"item_level_discount_amount": 0,
"object": "line_item",
"pricing_model": "flat_fee",
"quantity": 1,
"tax_amount": 0,
"unit_amount": 1000
},
{..}
],
"object": "quote",
"operation_type": "onetime_invoice",
"price_type": "tax_exclusive",
"resource_version": 1517501496000,
"status": "open",
"sub_total": 1000,
"taxes": [],
"total": 1000,
"total_payable": 1000,
"updated_at": 1517501496,
"valid_till": 1517596199,
"version": 1
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/create_for_onetime_charges
optional, string, max chars=100
The quote name will be used as the pdf name of the quote.
required, string, max chars=50
Identifier of the customer for which the quote needs to be created.
optional, string, max chars=100
Purchase Order Number for this quote.
optional, string, max chars=2000
Notes specific to this quote that you want customers to see on the quote PDF.
optional, timestamp(UTC) in seconds
Quotes will be vaild till this date. After this quote will be marked as closed.
required if Multicurrency is enabled, string, max chars=3
The currency code (ISO 4217 format) of the quote.
optional, string, max chars=100
The 'One Time' coupon to be applied.
optional, list of string
List of Coupons to be added.
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
shipping_address[country]
optional, string, max chars=50The 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.
shipping_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Returned for quantity-based plans when
multi-decimal pricing is enabled.
optional, in cents, min=0The 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_price
provided 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.
addons[unit_price_in_decimal][0..n]
optional, string, max chars=39The 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_decimal
provided 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.
addons[service_period][0..n]
Parameters for charges. Multiple charges can be passed by specifying unique indices.
pass parameters as charges[<param name>][<idx:0..n>]
optional, in cents, min=1The amount to be charged. The unit depends on the
type of currency.
charges[amount_in_decimal][0..n]
optional, string, max chars=39The 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.
charges[description][0..n]
optional, string, max chars=250
Description for this charge
charges[avalara_sale_type][0..n]
optional, enumerated stringIndicates 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
charges[avalara_transaction_type][0..n]
optional, integerIndicates 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.
charges[avalara_service_type][0..n]
optional, integerIndicates 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.
charges[service_period][0..n]
optional, integer
Service period for charge
always returned
Resource object representing quote
optional
Resource object representing quoted_charge
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 ]
Show more...
{"quote": {
"amount_due": 1000,
"amount_paid": 0,
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"object": "billing_address",
"validation_status": "not_validated"
},
"charge_on_acceptance": 1000,
"credits_applied": 0,
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWTMR3Bb",
"date": 1517501498,
"id": "6",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 1000,
"customer_id": "__test__KyVnHhSBWTMR3Bb",
"date_from": 1517501498,
"date_to": 1517501498,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTMVyBp",
"is_taxed": false,
"item_level_discount_amount": 0,
"object": "line_item",
"pricing_model": "flat_fee",
"quantity": 1,
"tax_amount": 0,
"unit_amount": 1000
},
{..}
],
"object": "quote",
"operation_type": "onetime_invoice",
"price_type": "tax_exclusive",
"resource_version": 1517501498000,
"status": "open",
"sub_total": 1000,
"taxes": [],
"total": 1000,
"total_payable": 1000,
"updated_at": 1517501498,
"valid_till": 1517596199,
"version": 2
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/edit_one_time_quote
optional, string, max chars=100
Purchase Order Number for this quote.
optional, string, max chars=2000
Notes specific to this quote that you want customers to see on the quote PDF.
optional, timestamp(UTC) in seconds
Quotes will be vaild till this date. After this quote will be marked as closed.
required if Multicurrency is enabled, string, max chars=3
The currency code (ISO 4217 format) of the quote.
optional, string, max chars=100
The 'One Time' coupon to be applied.
optional, list of string
List of Coupons to be added.
Parameters for shipping_address
pass parameters as shipping_address[<param name>]
shipping_address[first_name]
optional, string, max chars=150
The first name of the contact.
shipping_address[last_name]
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
shipping_address[company]
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1
optional, string, max chars=150
Address line 2
optional, string, max chars=150
Address line 3
optional, string, max chars=50
The name of the city.
shipping_address[state_code]
optional, string, max chars=50The
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 state_code
is provided.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
shipping_address[country]
optional, string, max chars=50The 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.
shipping_address[validation_status]
optional, enumerated string, default=not_validatedThe 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>]
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model
other than flat_fee
.
addons[quantity_in_decimal][0..n]
optional, string, max chars=33The decimal representation of the quantity of the addon. Returned for quantity-based plans when
multi-decimal pricing is enabled.
optional, in cents, min=0The 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_price
provided 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.
addons[unit_price_in_decimal][0..n]
optional, string, max chars=39The 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_decimal
provided 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.
addons[service_period][0..n]
Parameters for charges. Multiple charges can be passed by specifying unique indices.
pass parameters as charges[<param name>][<idx:0..n>]
optional, in cents, min=1The amount to be charged. The unit depends on the
type of currency.
charges[amount_in_decimal][0..n]
optional, string, max chars=39The 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.
charges[description][0..n]
optional, string, max chars=250
Description for this charge
charges[avalara_sale_type][0..n]
optional, enumerated stringIndicates 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
charges[avalara_transaction_type][0..n]
optional, integerIndicates 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.
charges[avalara_service_type][0..n]
optional, integerIndicates 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.
charges[service_period][0..n]
optional, integer
Service period for charge
always returned
Resource object representing quote
optional
Resource object representing quoted_charge
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
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 ]
Show more...
{"list": [
{"quote": {
"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__KyVnHhSBWTMYaBr",
"date": 1517501498,
"id": "7",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 500,
"customer_id": "__test__KyVnHhSBWTMYaBr",
"date_from": 1517501498,
"date_to": 1517501498,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTMbVC0",
"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": 1517501498000,
"status": "accepted",
"sub_total": 500,
"taxes": [],
"total": 500,
"total_payable": 500,
"updated_at": 1517501498,
"valid_till": 1517596199,
"version": 1
}},
{..}
]}
URL Format GET
https://{site}.chargebee.com/api/v2/quotes
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset
to the value of next_offset
obtained in the previous iteration of the API call.
optional, boolean, default=false
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, string filter
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
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
The identifier of the customer this quote belongs to.
Supported operators : is, is_not, starts_with, in, not_in
Example → customer_id[is] = "4gmiXbsjdm"
subscription_id[<operator>]
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] = "4gmiXbsjdm"
optional, enumerated 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, timestamp(UTC) in seconds filter
Creation date of the quote. Typically this is the date on which quote is generated.
Supported operators : after, before, on, between
Example → date[before] = "1435054328"
optional, timestamp(UTC) in seconds filter
To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
Supported operators : after, before, on, between
Example → updated_at[after] = "1243545465"
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
next_offset
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 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
curl https://{site}.chargebee.com/api/v2/quotes/9/quote_line_groups \
-G \
-u {site_api_key}:
Sample Response [ JSON ]
Show more...
{"list": [
{"quote_line_group": {
"id": "qlg___dev__XpbSss5Rp3qHPdF",
"sub_total": 67,
"total": 67,
"credits_applied": 0,
"amount_paid": 0,
"amount_due": 67,
"charge_event": "subscription_change",
"object": "quote_line_group",
"line_items": [
{
"id": "__dev__XpbSss5Rp3qHPeG",
"date_from": 1580385923,
"date_to": 1582199436,
"unit_amount": 67,
"quantity": 1,
"amount": 67,
"pricing_model": "per_unit",
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"customer_id": "active_direct",
"description": "SMS Credits - Prorated Charges",
"entity_type": "addon",
"entity_id": "sms-credits",
"discount_amount": 0,
"item_level_discount_amount": 0
},
{..}
],
"line_item_discounts": [],
"taxes": [],
"line_item_taxes": []
}},
{..}
]}
URL Format GET
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/quote_line_groups
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset
to the value of next_offset
obtained in the previous iteration of the API call.
always returned
Resource object representing quote_line_group
next_offset
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 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
curl https://{site}.chargebee.com/api/v2/quotes/1/convert \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
Show more...
{
"customer": {
"allow_direct_debit": false,
"auto_collection": "on",
"card_status": "valid",
"created_at": 1517501494,
"deleted": false,
"excess_payments": 0,
"first_name": "John",
"id": "__test__KyVnHhSBWTLXiAV",
"last_name": "Doe",
"net_term_days": 0,
"object": "customer",
"payment_method": {
"gateway": "chargebee",
"gateway_account_id": "gw___test__KyVnGlSBWTLQFYI",
"object": "payment_method",
"reference_id": "tok___test__KyVnHhSBWTLYlAW",
"status": "valid",
"type": "card"
},
"pii_cleared": "active",
"preferred_currency_code": "USD",
"primary_payment_source_id": "pm___test__KyVnHhSBWTLYpAX",
"promotional_credits": 0,
"refundable_credits": 0,
"resource_version": 1517501494000,
"taxability": "taxable",
"unbilled_charges": 0,
"updated_at": 1517501494
},
"invoice": {
"adjustment_credit_notes": [],
"amount_adjusted": 0,
"amount_due": 0,
"amount_paid": 500,
"amount_to_collect": 0,
"applied_credits": [],
"base_currency_code": "USD",
"billing_address": {
"first_name": "John",
"last_name": "Doe",
"object": "billing_address",
"validation_status": "not_validated"
},
"credits_applied": 0,
"currency_code": "USD",
"customer_id": "__test__KyVnHhSBWTLXiAV",
"date": 1517501496,
"deleted": false,
"due_date": 1517501496,
"dunning_attempts": [],
"exchange_rate": 1,
"first_invoice": true,
"has_advance_charges": false,
"id": "__demo_inv__1",
"is_gifted": false,
"issued_credit_notes": [],
"line_items": [
{
"amount": 500,
"customer_id": "__test__KyVnHhSBWTLXiAV",
"date_from": 1517501495,
"date_to": 1517501495,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "li___test__KyVnHhSBWTLvMAi",
"is_taxed": false,
"item_level_discount_amount": 0,
"object": "line_item",
"pricing_model": "flat_fee",
"quantity": 1,
"tax_amount": 0,
"tax_exempt_reason": "tax_not_configured",
"unit_amount": 500
},
{..}
],
"linked_orders": [],
"linked_payments": [
{
"applied_amount": 500,
"applied_at": 1517501496,
"txn_amount": 500,
"txn_date": 1517501496,
"txn_id": "txn___test__KyVnHhSBWTLvqAj",
"txn_status": "success"
},
{..}
],
"net_term_days": 0,
"new_sales_amount": 500,
"object": "invoice",
"paid_at": 1517501496,
"price_type": "tax_exclusive",
"recurring": false,
"resource_version": 1517501496000,
"round_off_amount": 0,
"status": "paid",
"sub_total": 500,
"tax": 0,
"term_finalized": true,
"total": 500,
"updated_at": 1517501496,
"write_off_amount": 0
},
"quote": {
"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__KyVnHhSBWTLXiAV",
"date": 1517501495,
"id": "1",
"invoice_id": "__demo_inv__1",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 500,
"customer_id": "__test__KyVnHhSBWTLXiAV",
"date_from": 1517501495,
"date_to": 1517501495,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTLsvAe",
"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": 1517501496000,
"status": "invoiced",
"sub_total": 500,
"taxes": [],
"total": 500,
"total_payable": 500,
"updated_at": 1517501496,
"valid_till": 1517596199,
"version": 1
}
}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/convert
optional, timestamp(UTC) in secondsThe 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_date
must be in the past.
invoice_date
is 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_date
or quoted_subscription.changes_scheduled_at
(whichever is applicable).
invoice_immediately
must be true
.
.
optional, booleanIf 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>]
optional, string, max chars=50
Applicable only for create subscription quote.
subscription[auto_collection]
optional, enumerated stringApplicable 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.
optional, string, max chars=100
Purchase order number for this subscription.
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
optional
Resource object representing quoted_charge
always returned
Resource object representing customer
optional
Resource object representing subscription
optional
Resource object representing invoice
optional
Resource object representing credit_note
optional
Resource object representing unbilled_charge
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 \
-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 ]
Show more...
{"quote": {
"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__KyVnHhSBWTO9dCc",
"date": 1517501504,
"id": "11",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 500,
"customer_id": "__test__KyVnHhSBWTO9dCc",
"date_from": 1517501504,
"date_to": 1517501504,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTOCyCl",
"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": "accepted",
"sub_total": 500,
"taxes": [],
"total": 500,
"total_payable": 500,
"updated_at": 1517501504,
"valid_till": 1517596199,
"version": 1
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/update_status
required, enumerated stringStatus to update for the quote.
Possible values are
acceptedAccepted.declinedDeclined.closedClosed
optional, string, max chars=300An 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.
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
optional
Resource object representing quoted_charge
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 \
-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 ]
Show more...
{"quote": {
"id": "5",
"customer_id": "__dev__KyVlEuRpeT0m25",
"status": "open",
"operation_type": "create_subscription_for_customer",
"price_type": "tax_exclusive",
"valid_till": 1581791399,
"date": 1580927607,
"total_payable": 1395,
"charge_on_acceptance": 1395,
"sub_total": 1395,
"total": 1395,
"credits_applied": 0,
"amount_paid": 0,
"amount_due": 1395,
"updated_at": 1580927607,
"resource_version": 1580927607468,
"object": "quote",
"line_items": [
{
"id": "__dev__KyVl9ORpeV7yI7",
"date_from": 1580927606,
"date_to": 1583433206,
"unit_amount": 900,
"quantity": 1,
"amount": 900,
"pricing_model": "per_unit",
"is_taxed": false,
"tax_amount": 0,
"object": "line_item",
"customer_id": "__dev__KyVlEuRpeT0m25",
"description": "No Trial",
"entity_type": "plan",
"entity_id": "no-trial",
"discount_amount": 0,
"item_level_discount_amount": 0
},
{..}
],
"line_item_discounts": [],
"taxes": [],
"line_item_taxes": [],
"currency_code": "USD"
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/extend_expiry_date
required, timestamp(UTC) in seconds
Quote will be valid till this date. After this date quote will be marked as closed.
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
optional
Resource object representing quoted_charge
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
curl https://{site}.chargebee.com/api/v2/quotes/5/delete \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
Show more...
{"quote": {
"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__KyVnHhSBWTMKSBP",
"date": 1517501497,
"id": "5",
"line_item_discounts": [],
"line_item_taxes": [],
"line_items": [
{
"amount": 500,
"customer_id": "__test__KyVnHhSBWTMKSBP",
"date_from": 1517501497,
"date_to": 1517501497,
"description": "Service Charge",
"discount_amount": 0,
"entity_type": "adhoc",
"id": "__test__KyVnHhSBWTMNIBY",
"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": 1517501497000,
"status": "open",
"sub_total": 500,
"taxes": [],
"total": 500,
"total_payable": 500,
"updated_at": 1517501497,
"valid_till": 1517596199,
"version": 1
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/delete
optional, string, max chars=300
Reason for deleting quote. This comment will be added to the subscription entity if the quote belongs to a subscription or added to the customer entity if the quote is associated only with a customer.
always returned
Resource object representing quote
optional
Resource object representing quoted_subscription
optional
Resource object representing quoted_charge
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
curl https://{site}.chargebee.com/api/v2/quotes/9/pdf \
-X POST \
-u {site_api_key}:
Sample Response [ JSON ]
Show more...
{"download": {
"download_url": "https://cb-local-downloads.s3.amazonaws.com/yourapp/quote/__test__KyVnHhSBWTNJvCQ.pdf?response-content-disposition=attachment%3Bfilename%3Dyourapp%2Fquote%2F__test__KyVnHhSBWTNJvCQ.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200924T161144Z&X-Amz-SignedHeaders=host&X-Amz-Expires=59&X-Amz-Credential=AKIAJI4SN7ONHAOGLOGA%2F20200924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=1f84cec770673dee4fab2bdfa55168a3b4010b0e3ba628a0dd42245e4ef64b29",
"object": "download",
"valid_till": 1600963964
}}
URL Format POST
https://{site}.chargebee.com/api/v2/quotes/{quote_id}/pdf
optional, boolean, default=false
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, enumerated string, default=attachmentDetermines the pdf should be rendered as inline or attachment in the browser.
Possible values are
attachmentPDF is rendered as attachment in the browserinlinePDF is rendered as inline in the browser
always returned
Resource object representing download