Download PDF
Download page Billing Recurring Products.
Billing Recurring Products
For recurring order line items, the API creates a cascade of billing schedule records depending on the term and billing frequency of the order line item.
To know how Billing works on the Conga Platform, it is recommended to familiarize yourself with its architecture mentioned in Understanding the Billing Architecture on Conga Platform.
Prerequisites
- An order line item is created for a recurring product.
The order line item is active.
If the OLI is active, the API will execute the logic, otherwise throws an error.
When you call the Initiate Billing API for a recurring order line item with OrderLineItemIds
and ReadyForBillingDate
as the payload, it starts processing the OLI. It creates one billing header, a cascade of billing schedule records, and billing schedule details depending on the term and billing frequency of the order line item. The billing schedule records are created with "Pending Billing" status and displays the following information:
- Bill To
- Period Start Date
- Period End Date
- Actual Fee Amount
- Ready for Invoice Date
This API is capable of handling several order line items and hence can process several line items in bulk.
Let's process a recurring product with the help of the following example.
Example
Suppose you have configured a recurring order line item with the following details:
Order No | Order Line No | Product | Price Type | Billing Frequency | Start Date | End Date | Quantity | Per Unit price | Net Price | Selling Term |
---|---|---|---|---|---|---|---|---|---|---|
O-001 | 1 | Services | Recurring | Monthly |
|
| 1 | USD 120.00 | USD 120.00 | 1.000 |
Contact your admin will make this functionality available in your application so that upon clicking a button you should be able to call the billing service API and get the result as shown. The API creates one Billing Header, 12 Billing Schedule Records, and 12 Billing Schedule Details.
The billing header uses the information from the order line item and contains the following data. Depending upon the information given for the pricing source, It will pick up the pricing information from the order line item or the asset line item. The Billing Header shows:
Billing Header ID | Order Ref. No. | Order Line No | Product | Price Type | Billing Frequency | Billing Rule | Start Date | End Date | Quantity | Net Unit Price | Selling Term | Bill To | Pricing Source | Billing Preference |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BH-001 | O-001 | 1 | Services | Recurring | Monthly | Bill In Advance |
|
| 1 | USD 120.00 | 1.000 | ABC Corporation | OLI | Billing Preference |
Twelve Billing Schedule Records are generated showing the following output:
Billing Schedule Record No | Billing Header ID | Period Start Date | Period End Date | Actual Fee Amount | Ready for Invoice Date | Status |
---|---|---|---|---|---|---|
BSR-001 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-002 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-003 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-004 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-005 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-006 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-007 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-008 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-009 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-010 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-011 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
BSR-012 | BH-001 |
|
| USD 10.00 |
| Pending Billing |
The Actual Fee Amount shown in the billing schedule record is the amount that is billed to the customer.
Billing Schedule Details show the following information:
Billing Schedule Detail No | Billing Schedule Record No | Record Type | Period Start Date | Period End Date | Category | Actual Fee Amount |
---|---|---|---|---|---|---|
BSD-001 | BSR-001 | Regular |
|
| Fee | USD 10.00 |
BSD-002 | BSR-002 | Regular |
|
| Fee | USD 10.00 |
BSD-003 | BSR-003 | Regular |
|
| Fee | USD 10.00 |
BSD-004 | BSR-004 | Regular |
|
| Fee | USD 10.00 |
BSD-005 | BSR-005 | Regular |
|
| Fee | USD 10.00 |
BSD-006 | BSR-006 | Regular |
|
| Fee | USD 10.00 |
BSD-007 | BSR-007 | Regular |
|
| Fee | USD 10.00 |
BSD-008 | BSR-008 | Regular |
|
| Fee | USD 10.00 |
BSD-009 | BSR-009 | Regular |
|
| Fee | USD 10.00 |
BSD-010 | BSR-010 | Regular |
|
| Fee | USD 10.00 |
BSD-011 | BSR-011 | Regular |
|
| Fee | USD 10.00 |
BSD-012 | BSR-012 | Regular |
|
| Fee | USD 10.00 |