Using AI coding agents like Claude Code or Cursor? Try the official Chargebee Agent Skills to speed up your development.Try now
ChargebeeAPI

Quote line groups

The line items of a quote are grouped by charge event. Each of these groups is called a quote line group. A quote would have at least one quote line group. Let's look at an example.

Consider the following:

  • A monthly plan A for $500 per month.
  • A non-recurring addon B for $50. Now consider a quote that is created for 3 billing cycles of the plan with the addon applied immediately. This quote would be associated with a list of quote line groups: one for each charge event as shown below:

Quote Line group 1

Plan A: $500

Addon B: $50

Total: $550

Quote Line group 2

Plan A: $500

Total: $500

Quote Line group 3

Plan A: $500

Total: $500

Sample Quote line groupJSON

API Index URL

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

Quote line groups attributes

version
optional, integer, default=1

Version of the quote line group.

id
optional, string, max chars=40

Uniquely identifies a quote line group.

sub_total
required, in cents, min=0

Subtotal in cents.

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

Total in cents.

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

Credits (in cents) applied to this quote line group.

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

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

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

Amount due in cents

charge_event
optional, enumerated string

Describes the time in the subscription lifecycle when the charge is to occur.

Enum Values
immediate

Immediate

subscription_creation

Subscription Creation

trial_start

Trial Start

subscription_change

Subscription Change

subscription_renewal

Subscription Renewal

subscription_cancel

Subscription Cancel

billing_cycle_number
optional, integer

The serial number of the billing cycle of which the quote line group is a part.

discounts

The list of discounts applied to this quote line group.

taxes

The list of taxes applied to this quote line group.

GROUPED:line_items|line_item_discounts|line_item_taxes
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_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>]