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
Quote line groups attributes
optional, in cents, default=0, min=0
Credits (in cents) applied to this quote line group.
optional, in cents, default=0, min=0
Existing outstanding payments (in cents) if any, applied to this quote line group.
optional, enumerated string
Describes the time in the subscription lifecycle when the charge is to occur.
immediate
Immediate
subscription_creation
Subscription Creation
trial_start
Trial Start
subscription_change
Subscription Change
subscription_renewal
Subscription Renewal
subscription_cancel
Subscription Cancel
optional, integer
The serial number of the billing cycle of which the quote line group is a part.