API Version
Product Catalog
Library

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 group [ JSON ]

{ "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": [] }

API Index URL

https://{site}.chargebee.com/api/v2/quote_line_groups

Model Class

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
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.
Possible values are
immediateImmediatesubscription_creationSubscription Creationtrial_startTrial Startsubscription_changeSubscription Change
Show all values[+]
billing_cycle_number
optional, integer
The serial number of the billing cycle of which the quote line group is a part.
optional, list of line_item
The list of items in this quote line group.
line_item_discounts
Show attributes [+]
optional, list of line_item_discount
The list of discount(s) applied for line items in this quote line group.
line_item_taxes
Show attributes [+]
optional, list of line_item_tax
The list of taxes applied on line items in this quote line group.
optional, list of discount
The list of discounts applied to this quote line group.
optional, list of tax
The list of taxes applied to this quote line group.
version version
optional, integer, default=1
Version of the quote line group.
id id
optional, string, max chars=40
Uniquely identifies a quote line group.
sub_total sub_total
in cents, min=0
Subtotal in cents.
total total
optional, in cents, default=0, min=0
Total in cents.
credits_applied credits_applied
optional, in cents, default=0, min=0
Credits (in cents) applied to this quote line group.
amount_paid amount_paid
optional, in cents, default=0, min=0
Existing outstanding payments (in cents) if any, applied to this quote line group.
amount_due amount_due
optional, in cents, default=0, min=0
Amount due in cents
charge_event charge_event
optional, enumerated string
Describes the time in the subscription lifecycle when the charge is to occur.
Possible values are
immediateImmediatesubscription_creationSubscription Creationtrial_startTrial Startsubscription_changeSubscription Change
Show all values[+]
billing_cycle_number billing_cycle_number
optional, integer
The serial number of the billing cycle of which the quote line group is a part.
line_items
optional, list of line_item
The list of items in this quote line group.
line_item_discounts
optional, list of line_item_discount
The list of discount(s) applied for line items in this quote line group.
line_item_taxes
optional, list of line_item_tax
The list of taxes applied on line items in this quote line group.
discounts
optional, list of discount
The list of discounts applied to this quote line group.
taxes
optional, list of tax
The list of taxes applied to this quote line group.