ChargebeeAPI

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

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.

Possible Enum Values
open

The quote is either newly created, or has been approved but not yet sent to the customer.

accepted

The customer has accepted the quote.

declined

The customer declined/rejected the quote.

invoiced

The accepted quote has been converted into a subscription or one-time charge and invoiced through Chargebee.

closed

The quote has been marked as closed.

Note

Not applicable when Chargebee CPQ is enabled.

pending_approval

The quote has been submitted for internal approval and is awaiting review.

Note

Applicable only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

approval_rejected

The quote was rejected with comments, allowing for revisions.

Note

Applicable only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

proposed

The quote has been shared with the customer via email or e-signature and is awaiting their response.

Note

Applicable only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

voided

The quote has been invalidated and can no longer be acted upon.

Note

Applicable only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

expired

The quote has passed its expiration date and is no longer valid.

Note

Applicable only when Chargebee CPQ is enabled. To request access, contact Chargebee Support.

operation_type
required, enumerated string

Operation Type

Possible 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.

Possible 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, jsonarray

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 unique ID of the business entity of this quote.

deleted
required, boolean

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

total_contract_value
optional, in cents, min=0

The total contract value of the quote.

Note: This parameter applies only when Chargebee CPQ is enabled. To request access, please contact support

total_discount
optional, in cents, min=0

The total discount value of the quote for the contract period.

Note: This parameter applies only when Chargebee CPQ is enabled. To request access, please contact support

discounts
optional, list of discount

The list of all deductions applied to the quote.

taxes
optional, list of tax

The list of taxes applicable for this quote.

shipping_address
optional, shipping_address

Shipping address for the quote.

billing_address
optional, billing_address

Billing address for the quote.

GROUPED:line_items|line_item_tiers|line_item_discounts|line_item_taxes
line_items
optional, list of line_item

The list of line items for this quote.

line_item_tiers
optional, list of line_item_tier

The list of tiers applicable for the various line items in this quote.

line_item_discounts
optional, list of line_item_discount

The list of deductions applied for each line item of this quote.

line_item_taxes
optional, list of line_item_tax

The list of taxes applied on the line items of this quote.