Quotes

A quote is an estimate of the invoice with the charges likely to occur when customers buy an item. A quote can be converted to a regular invoice once the customer accepts it.

The line items of a quote are grouped by charge events and are available as a separate resource. This resource can be retrieved using the List quote line groups endpoint. Note that the first quote line group is available within the quote resource itself and parsing the quote line groups object is not required.

Sample QuoteJSON

API Index URL

https://[site].chargebee.com/api/v2/quotes

Quotes attributes

id

required, string, max chars=50

The quote number. Acts as a identifier for quote and typically generated sequentially.

name

optional, string, max chars=100

The quote name will be used as the pdf name of the quote.

po_number

optional, string, max chars=100

Purchase Order Number

customer_id

required, string, max chars=50

The identifier of the customer this quote belongs to.

subscription_id

optional, string, max chars=50

The identifier of the subscription this quote belongs to.

invoice_id

optional, string, max chars=50

The identifier of the invoice generated while converting this quote.

status

required, enumerated string

Current status of this quote.

Enum Values

open

Open

accepted

Accepted.

declined

Declined.

invoiced

Invoiced

closed

Closed

pending_approval

approval_rejected

proposed

voided

expired

operation_type

required, enumerated string

Operation Type

Enum Values

create_subscription_for_customer

create_subscription_for_customer

change_subscription

change_subscription

onetime_invoice

onetime_invoice

renew_subscription

vat_number

optional, string, max chars=20

VAT/ Tax registration number of the customer. Learn more

price_type

required, enumerated string, default=tax_exclusive

The price type of the quote.

Enum Values

tax_exclusive

All amounts in the document are exclusive of tax.

tax_inclusive

All amounts in the document are inclusive of tax.

valid_till

required, timestamp(UTC) in seconds

Quote will be valid till this date. After this date quote will be marked as closed.

date

required, timestamp(UTC) in seconds

Creation date of the quote. Typically this is the date on which quote is generated.

total_payable

optional, in cents, min=0

Total contract value. Applicable when multi billing cycle quote is enabled.

charge_on_acceptance

optional, in cents, default=0, min=0

Charge on acceptance. Applicable when multi billing cycle quote is enabled.

sub_total

required, in cents, min=0

Subtotal (in cents) of the first quote line group.

total

optional, in cents, default=0, min=0

Total (in cents) of the first quote line group.

credits_applied

optional, in cents, default=0, min=0

Credits applied (in cents) for the first quote line group.

amount_paid

optional, in cents, default=0, min=0

Existing outstanding payments (in cents) if any, applied to the first quote line group.

amount_due

optional, in cents, default=0, min=0

Amount due (in cents) for the first quote line group.

version

optional, integer, default=1

Version of the quote.

resource_version

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.

updated_at

optional, timestamp(UTC) in seconds

Timestamp indicating when this quote was last updated.

vat_number_prefix

optional, string, max chars=10

An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address

country as XI (which is United Kingdom - Northern Ireland ).

When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting billing_address

country as XI. That's the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is XI by default. However, if the VAT number was registered in UK, the value should be GB. Set vat_number_prefix to GB for such cases.

tax_category

optional, string

Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.

currency_code

required, string, max chars=3

The currency code (ISO 4217 format) of the quote.

notes

optional

List of notes associated with this quotes.

contract_term_start

optional, timestamp(UTC) in seconds

Specifies the contract term's start date.

contract_term_end

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.

business_entity_id

optional, string, max chars=50

The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.

Note

Multiple Business Entities is a feature available only on Product Catalog 2.0.

deleted

required, boolean

Indicates that this resource has been deleted when the value is true .

total_contract_value

optional, in cents, min=0

total_discount

optional, in cents, min=0

discounts

The list of all deductions applied to the quote.

taxes

The list of taxes applicable for this quote.

shipping_address

Shipping address for the quote.

billing_address

Billing address for the quote.

line_items[0..n]

Parameters for line_items. Multiple line_items can be passed by specifying unique indices.

pass parameters as line_items[<param name>][<idx:0..n>]

line_item_tiers[0..n]

Parameters for line_item_tiers. Multiple line_item_tiers can be passed by specifying unique indices.

pass parameters as line_item_tiers[<param name>][<idx:0..n>]

line_item_discounts[0..n]

Parameters for line_item_discounts. Multiple line_item_discounts can be passed by specifying unique indices.

pass parameters as line_item_discounts[<param name>][<idx:0..n>]

line_item_taxes[0..n]

Parameters for line_item_taxes. Multiple line_item_taxes can be passed by specifying unique indices.

pass parameters as line_item_taxes[<param name>][<idx:0..n>]