Download PDF
Download page Creating a Custom Plan.
Creating a Custom Plan
You can create a custom plan using an already-created plan template. You can create a custom plan for:
- An Order Line Item (OLI) or a set of OLIs containing One-Time or Recurring products.
- A Line Item (CPQ cart line) or a set of Line Items containing One-Time or Recurring products.
A Custom Plan can be of a Milestone or Term Based type.
Currently, the API works for the Standalone products. It may not work for some of the Bundle scenarios.
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.
Creating a Milestone Plan Using a Template for an OLI and ALI
Before you start creating a milestone custom plan, you must create a plan template. To know more about how to create a plan template, see Creating a Plan Template.
The requirement is to bill the customer in two installments, 30% of the contract amount on the 3rd day of the first month and the remaining 70% after one month. You have supplied the following details in the plan template:
Plan Template ID | Plan Type | Periods Needed | Number of Installments | Based On | Computation Method | Start Date Based On | Active |
---|---|---|---|---|---|---|---|
PT-1 | Milestone | False | 2 | Percentage | Custom | Start Date from the Line Item | False |
Details of the two lines (because the number of installments is two, hence two line items) are as follows:
ID | Plan Template ID | Offset Type | Offset Number | Percent | Payment Term |
---|---|---|---|---|---|
PTL-1 | PT-1 | Days | 3 | 30 | Term 1 |
PTL-2 | PT-1 | Month | 1 | 70 | Term 2 |
Once the above template is "Active," it can be used to create a custom plan using an API. You'll now see how a Plan is created for the transaction lines (OLIs/Line Items) using the above template.
There are some prerequisites to keep in mind.
Prerequisites
- For creating a custom plan for an OLI
OLI is not Activated.
The order is not Activated.
The intended OLI for which a billing plan is to be created must refer to the same Order.
- For creating a custom plan for Line Items
- The intended Line Items for which a billing plan is to be created must refer to the same Proposal.
API Input Parameters
To create a custom plan you must enter the following parameters for every set of OLI or ALI:
- Name: My_Custom_Plan_1
Use Plan Template: True
If you have marked this field as
True
, you must enter the plan template ID in the next step.- Plan Template ID: PT-1
Description: Optionally give a description like Custom Plan for ABC Company
OLI ID or Line Item ID: O-1 or Line Item-1
The start date is (start date on OLI). When the custom plan is created it shows the following values:
Custom Plan ID | ID (Order or Proposal) | Plan Template | Description | Name | No. of Installments | Plan Type | Periods Needed | Based On | Computation Method | Status |
---|---|---|---|---|---|---|---|---|---|---|
CP-1 | O-1 | PT-1 | Custom Plan for ABC Company | My_Custom_Plan_1 | 2 | Milestone | False | Percentage | Custom | New |
The Plan Items for the OLIs (or Line Items) will be auto-created with the following details:
ID | Custom Plan ID | Percent | Milestone Expected Date | Payment Term |
---|---|---|---|---|
CPL-1 | CP-1 | 30 |
| Term 1 |
CPL-2 | CP-1 | 70 |
| Term 2 |
When you initiate billing, the Billing Header will have two Billing Schedule Records containing 30% and 70% of the TCV (Sales) respectively.
Creating a Term-Based Plan Using a Template for an OLI and ALI
Before you start creating a term-based custom plan, you must create a plan template. To know more about how to create a plan template, see Creating a Plan Template.
The requirement is to bill the customer in three equal installments, in the fourth month, the seventh month, and the ninth month. You have supplied the following details in the plan template:
Name | Plan Type | Periods Needed | Number of Installments | Based On | Computation Method | Start Date Based On | Active |
---|---|---|---|---|---|---|---|
PT-2 | Term based | True | 3 | Percentage | Equal Distribution | Start Date from the Line Item | False |
Details of the three lines (because the number of installments is 3, hence three line items) are as follows:
ID | Plan Template ID | Offset Type | Offset Number | Percent | Payment Term |
---|---|---|---|---|---|
PTL-1 | PT-2 | Month | 1 | NA | Term 1 |
PTL-2 | PT-2 | Month | 3 | NA | Term 2 |
PTL-3 | PT-2 | Month | 2 | NA | Term 3 |
Once the above template is "Active," it can be used to create a custom plan using an API. You'll now see how a Plan is created for the transaction lines (OLIs or Line Items) using the above template.
Prerequisites and input parameters remain the same as mentioned in Creating a Milestone Custom Plan using a Template for an OLI and ALI.
The start date is and the end date is (start and end date of the OLI). When the custom plan is created it shows the following values:
Custom Plan ID | ID (Order or Proposal) | Plan Template | Description | Name | No. of Installments | Plan Type | Periods Needed | Based On | Computation Method | Status |
---|---|---|---|---|---|---|---|---|---|---|
CP-1 | O-2 | PT-2 | Custom Plan for ABC Company | My_Custom_Plan_1 | 3 | Term Based | False | Percentage | Custom | New |
The Plan Items for the OLIs (or Line Items) will be auto-created with the following details:
ID | Custom Plan ID | Percent | Period Start Date | Period End Date | Ready For Invoice Date | Payment Term |
---|---|---|---|---|---|---|
CPL-1 | CP-2 | 33.33333 |
|
|
| Term 1 |
CPL-2 | CP-2 | 33.33333 |
|
|
| Term 2 |
CPL-3 | CP-2 | 33.33333 |
|
|
| Term 3 |
When you initiate billing, the Billing Header will have three Billing Schedule Records containing 33.33333% of the TCV (Sales) respectively.