Direct Term-based Custom Plan
You can create direct term-based custom plans without using a plan template. You can create this plan for a line item(s) or order line item(s) (OLIs), containing one-time or recurring products.
You can define this plan with or without any period range for the plan line items. If the Periods Needed is set to True, the Start Date of the subsequent installments cannot be before the start of the previous installments and the Ready for Invoice Date must be in the range of Period Start Date and Period End Date.
Parameters for Plan Header
Enter the following parameters for the plan header of every set of OLIs or Line Items:
| Parameter | Value |
|---|---|
| Name | Name of the custom plan, for example, My_Custom_Plan_1 |
| Use Plan Template (Required if you create a custom plan using API) | False |
| Plan Template ID (Required if you create a custom plan using API) | ID of the plan template. For direct custom plans leave it blank. |
| Plan Type | Milestone or Term Based |
| Periods Needed | True or False |
| Number of Installments | Specify the number of payment installments, for example, 3 |
| Based On | Percentage or Amount |
| Computation Method | Custom or Even Distribution |
| Description | Describe the custom plan (optional) |
| LineItemIds or OrderLineItemIds (Required if you create a custom plan using API) | Set of LineItem(s) or OrderLineItem(s) IDs |
| Billing Amount Criterion | Indicates whether to bill based on the delta revenue or the revenue indicated in the net price. It has two values -
The default value is Bill the Net Price. If you chose to bill the net price, the billing logic is invoked to calculate the net price. This net price is used to calculate the installment amounts per the new custom plan. The billing records generated during the new sale, if outside the amendment, remain untouched. The billing records falling inside the amendment period:
|
Parameters or Rules for Plan Line Items
| Parameters | Rule, Periods Needed = False | Rule, Periods Needed = True |
|---|---|---|
| Period Start Date | (Optional) Billing period start date. Auto-populates the ready-for-invoice date if left blank. | You must enter a date which is before, during or after the contract date. The start date of subsequent installments cannot be before the start of the previous installment. It can be on the same date as the previous installment or after. |
| Period End Date | Required only if you have entered the period start date. The value must be greater than or equal to the period start date. If left blank, the API auto-populates it to the max value from the Ready for Invoice Date or Period Start Date. | The date must be in the range of Period Start Date and Ready for Invoice Date. |
| Ready for Invoice Date Note: Only for Tem Based custom plans | Date when the customer will be invoiced. | Ready for Invoice Date per line item is greater than or equal to the Period Start Date of that installment and equal to or higher than the Ready for Invoice Date of the previous installment. |
| Milestone Expected Date Note: Only for Milestone custom plans | Date when the milestone is expected to be completed. You must enter a date for this field. It can be within or outside the contract date. The dates for subsequent installments need not be in a linear order. The milestone expected date of the second installment can be the same, before, or after the first installment's date. | |
| Payment Term | The payment term associated with the plan. | |
| Percentage | The percentage of each installment. The sum of percentages of all the installments must be equal to 100. To increase the precision of the forecasted amounts, you must mention eight digits of decimal precision wherever applicable (e.g., 33.33333333, 7.14285714, etc.). | |
| Comments | Write your comments (optional). | |
There is a new sale of a recurring product with TCV (Sales) of USD 10,000.00 and monthly billing frequency. The requirement is to bill the customer in three installments. You created a term based custom plan with three line items containing 40.33333333%, 25.33333333%, and 34.33333334%. You entered the following parameters for the plan header:
| Name | Plan Type | Periods Needed | No. of Installments | Based On | Computation Method | Description |
|---|---|---|---|---|---|---|
| My_Custom_Plan_1 | Term -based | False | 3 | Percentage | Custom | Custom Plan for ABC Company |
Because there are three installments, you must provide the line item details for three plan lines. If you have enabled the Fee Amount Rounding Schedule setting at the Billing Setting level, the engine auto-computes the first or last value in the percent field. This is elaborated in Rounding the Values and Auto-Computation.
| Period Start Date | Period End Date | Ready for Invoice Date | Percent | Payment Term | Comments |
|---|---|---|---|---|---|
| 01-January-2025 | 20-January-2025 | 20-January-2025 | 40.33333333 | NET 30 | Comment 1 |
| 21-January-2025 | 15-March-2025 | 15-March-2025 | 25.33333333 | NET 60 | Comment 2 |
| 16-March-2025 | 25-July-2025 | 25-July-2025 | 34.33333334 | NET 90 | Comment 3 |
When you initiate the billing, the billing header, three billing schedule records (BSRs), and three billing schedule details are created. The billing header contains the custom plan information.
| Name | Current OLI | Billing Frequency | Billing Start Date | Billing End Date | TCV (Sales) | Custom Plan | Billable Amount for Current OLI | Status |
|---|---|---|---|---|---|---|---|---|
| BH-1 | OLI-1 | Monthly | 01-January-2025 | 31-December-2025 | USD 10,000.00 | Custom plan ID | USD 10,000.00 | Active |
The BSRs are:
| Name | Period Start Date | Period End Date | Ready for Invoice Date | Actual Fee Amount | Invoice Status |
|---|---|---|---|---|---|
| BSR-1 | 01-January-2025 | 20-January-2025 | 20-January-2025 | USD 4,033.33 | Pending Billing |
| BSR-2 | 21-January-2025 | 15-March-2025 | 15-March-2025 | USD 2,533.33 | Pending Billing |
| BSR-3 | 16-March-2025 | 25-July-2025 | 25-July-2025 | USD 3,433.34 | Pending Billing |
The BSDs are:
| Name | Record Type | Period Start Date | Period End Date | Ready for Invoice Date | Actual Fee Amount | Derived Invoice Status | Description |
|---|---|---|---|---|---|---|---|
| BSD-1 | Custom Plan Line | 01-January-2025 | 20-January-2025 | 20-January-2025 | USD 4,033.33 | Pending | Installment-1 |
| BSD-2 | Custom Plan Line | 21-January-2025 | 15-March-2025 | 15-March-2025 | USD 2,533.33 | Pending | Installment-2 |
| BSD-3 | Custom Plan Line | 16-March-2025 | 25-July-2025 | 25-July-2025 | USD 3,433.34 | Pending | Installment-3 |
Creating a Direct Custom Plan
- For an Order Line Item (OLI):
- The order and all selected OLIs must be in a non-activated status.
- All selected OLIs must belong to the same order.
- For a cart Line Item:
- All selected line items must refer to the same configuration ID.
- The proposal must not be in accepted status.
