You can query and retrieve the custom plans along with the line items that were previously created. The search criteria can be the name containing, plan ID, order ID, proposal ID, order line item ID, or line item ID.

You cannot do a blank search. You must provide at least one value from plan ID, name, order ID, proposal ID, order line item ID, or line item ID in the search field.

To Query and Retrieve the Custom Plans

  1. Call the Billing Management API, https://<URL_of_the_Instance>/api/billing/v1/custom-plans/search.
  2. Enter at least one of the following API input values in the payload. The query treats each parameter with an OR condition and increases the number of search results with an increase in search parameters.
    1. ID: ID of the custom plan.
    2. Name Containing: Name of the custom plan or null.
    3. Order ID: ID of the order under which the custom plan is created or null.
    4. Order Line Item ID: ID of the order line item or null.
    5. Proposal ID: ID of the proposal or null.
    6. Line Item ID (Proposal Cart): ID of the line item or null.
  3. The API queries and retrieves the custom plan and its line items. It shows the following fields on the custom plan header and the line items under the plan.
    Fields on the custom plan header:
    1. ID: ID of the custom plan.
    2. Name: Name of the custom plan.
    3. Plan Type: Milestone or Term-based custom plan
    4. Periods Needed: True or False.
    5. Number of Installments: The number of installments on the custom plan, is equal to the line numbers on the plan.
    6. Based On: Percentage or Amount
    7. Computation Method: Custom or Even Distribution.
    8. Description: Description of the custom plan.
    9. Order: ID of the order.
    10. Proposal: ID of the proposal.

Fields on the line items under the plan:

    1. ID: ID of the plan line item.
    2. Name: Name of the plan line item.
    3. Period Start Date: Start date of the plan line item.
    4. Period End Date: End date of the plan line item.
    5. Ready for Invoice Date: Ready for invoice date of the plan line item.

    6. Percent: The percentage of the total price to be computed for the installment.

    7. Payment Term: The payment term for the installment.
    8. Milestone Expected Date: The date when the milestone is to be completed.

    9. Comments: Comments if any.