You are viewing the documentation for Chargebee API V2. If you're using the older version (V1), click here.
When the operation_type of a quote is onetime_invoice, the quoted_charges resource contains the details of the invoice that is eventually created once the quote is invoiced. It is always returned along with the quote.

Sample quoted charge [ JSON ]

{ "object": "quoted_charge", "invoice_items": [ { "item_price_id": "charge-USD", "quantity": 1, "quantity_in_decimal": "1", "unit_price": 10000, "unit_price_in_decimal": "100.00", "service_period_days": 11, "object": "item_price" }, {..} ], "charges": [ { "amount": 2100, "amount_in_decimal": "21.00", "description": "Initial Hardware", "object": "charge", "service_period_in_days": 11 }, {..} ] }
optional, list of charge
Provides details of all the ad-hoc charges added to the quote.
Charge attributes
amount
optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.
amount_in_decimal
optional, string, max chars=39
The decimal representation of the amount for the one-time charge. The value is in major units of the currency. Applicable only when multi-decimal pricing is enabled.
description
optional, string, max chars=250
Description for this charge
service_period_in_days
optional, integer, min=1, max=730
Specifies the service period of the charge in days. When the quote is converted, the invoice.line_item.date_from is set to current date/time and invoice.line_item.date_to is set to service_period_in_days ahead of date_from.
avalara_sale_type
optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
avalara_transaction_type
optional, integer
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
avalara_service_type
optional, integer
Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
optional, list of addon
Provides details of the addons that are part of the quote.
Addon attributes
id
string, max chars=100
Identifier of the addon. Multiple addons can be passed.
quantity
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.
unit_price
optional, in cents, min=0

The price or per-unit-price of the addon. The value depends on the type of currency.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

  • The unit_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.

quantity_in_decimal
optional, string, max chars=33
The decimal representation of the quantity of the addon. Returned for quantity-based plans when multi-decimal pricing is enabled.
unit_price_in_decimal
optional, string, max chars=39

The decimal representation of the price or per-unit price of the addon. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

  • The unit_price_in_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.

service_period
optional, integer
Specifies the service period of the addon in days. When the quote is converted, the invoice.line_item.date_from is set to current date/time and invoice.line_item.date_to is set to service_period days ahead of date_from.
optional, list of coupon
List of coupons for this charge
Coupon attributes
coupon_id
string, max chars=100
Used to uniquely identify the coupon