The billing header of a product has fields that keep on updating when new billing schedule records (BSRs) are created because of renewal functionality or when new billing schedule details (BSDs) are created to include the adjustments related to miscellaneous charges.

Updating the Total Adjusted Amount Field

The Total Adjusted Amount field on the billing header stores the amount arising due to adjustments done on any of the BSRs. For more information on how to do the adjustments, see Adjusting the Billing Amount with Manual Entries. The adjusted amount is rolled up to the BH and is added to the existing value (if any) in the Total Adjusted Amount field.

Consider the following example:

An Evergreen service is billed for USD 1,200.00 every quarter. The TCV (Sales) field on the BH has a value of USD 1,200.00. Billing is initiated, and four BSRs (BSR-1, BSR-2, BSR-3, and BSR-4) are created with a fee amount of USD 300.00 and invoiced. 

The auto-renewal term is set to 2, hence two new BSRs are created because of auto-renewal functionality.

BSR ID

BH ID

Period Start Date

Period End Date

Actual Fee Amount

Status

BSR-5BH-101-March-202431-May-2024USD 300.00Pending Billing
BSR-6BH-101-June-202431-Aug-2024USD 300.00Pending Billing

In the above example, say you have created an adjustment of USD 50.00 on BSR-5. A new BSD-5 is created with a fee amount of USD 50.00.

BSR ID

BSR Fee Amount

BSD ID

Period Start Date

Period End Date

Category 

Actual Fee Amount

BSD Status

BSR-5USD 350.00BSD-501-March-202431-May-2024AdjustmentUSD 50.00Approved

The adjusted amount of USD 50.00 is rolled up to the BH and the Total Adjusted Amount field on the BH is updated to USD 50.00.

Updating the Total Bill Including Adjustments Field

The total bill including adjustments reflects the total amount as a sum of TCV (Sales) and the total adjusted amount. This is the total bill amount payable by the customer.

Considering the above example, 

Total Bill Including Adjustments = TCV (Sales) + Total Adjusted Amount = USD 1,200.00 + USD 50.00 = USD 1,250.00.

Updating the Billing Preference Field

When the renewal of a product or service is initiated through a renewal OLI, the API creates the renewal BSRs per the values in the new billing preference on that renewal transaction.

Example

For a new sale, the billing start date is 01-Jul-2023, the billing end date is 30-Jun-2024, the billing frequency is quarterly, and TCV (Sales) is USD 1,200.00. You initiated the billing so that four BSRs are generated. The fee amount of the BSRs is USD 300.00 each. Consider the following scenarios:

ScenarioConditionBilling PreferenceBilling Header

No changes to the billing preference 
and its values

Before renewal

BP-00001

Billing Cycle Start = Billing Day of Month

Billing Day of Month = 1st of the Month

Billing Day of Week = <None>

Calendar Cycle Start = <None>

Billing Interval = Anytime

Billing Start Date = 01-Jul-2023

Billing End Date = 30-Jun-2024

Billing Frequency = Quarterly

Billing Preference = BP-00001

TCV (Sales) = USD 1,200.00

Number of BSRs = 04

BSR-1: 01-Jul-2023 to 30-Sep-2023 with a fee of USD 300.00

BSR-2: 01-Oct-2023 to 31-Dec-2023 with a fee of USD 300.00

BSR-3: 01-Jan-2024 to 31-Mar-2024 with a fee of USD 300.00

BSR-4: 01-Apr-2024 to 30-Jun-2024 with a fee of USD 300.00

First renewal: The asset is renewed for
one year, TCV (Sales) increased to USD 2,440.00

No change in billing preference and its values

Billing Start Date = 01-Jul-2024

Billing End Date = 30-Jun-2025

Billing Frequency = Quarterly

Billing Preference = BP-00001

TCV (Sales) = USD 2,440.00

Number of BSRs = 04

BSR-5: 01-Jul-2024 to 30-Sep-2024 with a fee of USD 310.00

BSR-6: 01-Oct-2024 to 31-Dec-2024 with a fee of USD 310.00

BSR-7: 01-Jan-2025 to 31-Mar-2025 with a fee of USD 310.00

BSR-8: 01-Apr-2025 to 30-Jun-2025 with a fee of USD 310.00

The preference ID remains the same, 
but values inside the preference change

Second renewal: The asset is renewed
for one year, TCV (Sales) increased to USD 3,720.00

BP-00001

Billing Cycle Start = Billing Day of Month

Billing Day of Month = 10th of the Month

Billing Day of Week = <None>

Calendar Cycle Start = <None>

Billing Interval = Anytime

Billing Start Date = 01-Jul-2025

Billing End Date = 30-Jun-2026

Billing Frequency = Quarterly

Billing Preference = BP-00001

TCV (Sales) = USD 3,720.00

Number of BSRs = 05

BSR-9: 01-Jul-2024 to 09-Jul-2024 with a fee of USD 106.67

BSR-10: 10-Jul-2024 to 09-Oct-2024 with a fee of USD 320.00

BSR-11: 10-Oct-2025 to 09-Jan-2025 with a fee of USD 320.00

BSR-12: 10-Jan-2025 to 09-Apr-2025 with a fee of USD 320.00

BSR-13: 10-Apr-2025 to 30-Jun-2025 with a fee of USD 213.33

The sum of partial periods equals USD 320.00 together.

Billing preference is changed

Third renewal: The asset is renewed for one year, and TCV (Sales) increased to USD 5040.00.

BP-00002

Billing Cycle Start = Period Start Date

Billing Day of Month = <None>

Billing Day of Week = <None>

Calendar Cycle Start = February

Billing Interval = Anytime

Billing Start Date = 01-Jul-2026

Billing End Date = 30-Jun-2027

Billing Frequency = Quarterly

Billing Preference = BP-00002

TCV (Sales) = USD 5,040.00

Number of BSRs = 05

BSR-14: 01-Jul-2026 to 31-Jul-2026 with a partial fee of USD 110.00

BSR-15: 01-Aug-2026 to 31-Oct-2026 with a fee of USD 330.00

BSR-16: 01-Nov-2026 to 31-Jan-2027 with a fee of USD 330.00

BSR-17: 01-Feb-2027 to 31-Apr-2027 with a fee of USD 330.00

BSR-18: 01-May-2027 to 30-Jun-2027 with a partial fee of USD 220.00.

Updating the Billing Frequency Field

When you change the billing frequency during the renewal operation, the API considers the updated value of the billing frequency on the billing header and creates the renewal BSRs per the renewal term and new billing frequency.

Example

A recurring product has a monthly billing frequency and TCV (Sales) is USD 1,200.00. The billing start date is 01-Jan-2024 and the billing end date is 31-Dec-2024. When the billing was initiated, the application created 12 BSRs under the BH for the year 2024. The product undergoes renewal in the year 2025 where the billing frequency remains unchanged. Consider the scenarios:

Before renewal

You initiated the billing so that twelve BSRs are generated. The fee amount of the BSRs is USD 100.00 each.

BSR-1: 01-Jan-2024 to 31-Jan-2024 with a fee of USD 100.00

BSR-2: 01-Feb-2024 to 29-Feb-2024 with a fee of USD 100.00

........

BSR-11: 01-Nov-2024 to 30-Nov-2024 with a fee of USD 100.00

BSR-12: 01-Dec-2024 to 31-Dec-2024 with a fee of USD 100.00

After renewal

You renewed the contract for one year, and the billing frequency and TCV (Sales) remain unchanged. Billing is initiated so that twelve BSRs are generated. The fee amount of the BSRs is USD 100.00 each.

BSR-1: 01-Jan-2025 to 31-Jan-2025 with a fee of USD 100.00

BSR-2: 01-Feb-2025 to 28-Feb-2025 with a fee of USD 100.00

........

BSR-11: 01-Nov-2025 to 30-Nov-2025 with a fee of USD 100.00

BSR-12: 01-Dec-2025 to 31-Dec-2025 with a fee of USD 100.00

You can see that for a renewal term of one year with a monthly billing frequency, twelve new billing schedules are created. If the billing frequency is changed to Quarterly, then the application creates four BSRs. Similarly, for a half-yearly billing frequency, it creates two BSRs and for a yearly billing frequency, it creates one BSR. Assuming that there are no partial periods, the following table summarizes the changes in billing frequency and the resultant number of BSRs generated:

Number of BSRs in 2024Billing frequency during renewal in 2025Number of BSRs created in 2025 per the new 
billing frequency
Combined number of BSRs in 2024 and 2025
12Monthly (billing frequency remains unchanged)1224 (12 + 12)
Quarterly (billing frequency changed to quarterly)0416 (12 + 4)

Half-yearly (billing frequency changed to half-yearly)

0214 (12 + 2)

Yearly (billing frequency changed to yearly)

0113 (12 + 1)

One-time (billing frequency changed to one-time)

0113 (12 + 1)

Updating the Billing Rule

When you update the billing rule on the billing header as a part of the renewal operation, the billing application populates the "new" Ready for Invoice Date field on the renewal BSRs per the new billing rule. If you modify the ready-for-invoice date for a period in an ongoing cycle, the modification is discarded during the renewal operation, and the ready-for-invoice date is populated per the new billing rule and not per your modified dates. Similarly, the application ignores splits on BSRs in an ongoing cycle during renewal.

Example

A recurring product's billing start date is 01-Jan-2024 and its billing end date is 31-Dec-2024. It has a quarterly billing frequency. There are no partial periods but there is a split in one of the quarters. The billing rule is "Bill in Advance". Initiating the billing creates four billing schedules. The application updates the ready-for-invoice date of BSR-002 to 10-Apr-2024 and splits BSR-003 into two new BSRs as the customer requires. All the BSRs are invoiced.

BSR IDPeriod Start DatePeriod End DateReady for Invoice DateInvoice StatusRemarks
BSR-00101-Jan-202431-Mar-202401-Jan-2024Invoiced
BSR-00201-Apr-202430-Jun-202410-Apr-2024InvoicedThe user modified the ready-for-invoice date during the new sale.
BSR-00301-Jul-202430-Sep-202401-Jul-2024SupersededBSR-003 is superseded because of a split.
BSR-003.a01-Jul-202431-Jul-202401-Jul-2024Invoiced
BSR-003.b01-Aug-202430-Sep-202401-Aug-2024Invoiced
BSR-00401-Oct-202431-Dec-202401-Oct-2024Invoiced

The product is renewed but the billing rule on the billing header remains "Bill in Advance". The effects of renewal on the ready-for-invoice date and the status of BSRs are as follows:

BSR IDPeriod Start DatePeriod End DateReady for Invoice DateInvoice StatusRemarks
BSR-00701-Jan-202531-Mar-202501-Jan-2025Pending Billing
BSR-00801-Apr-202530-Jun-202501-Apr-2025Pending Billing

The application discards the user-mentioned value during renewal and updates the ready-for-invoice date per the billing rule.

BSR-00901-Jul-202530-Sep-202501-Jul-2025Pending BillingThe split in the same period during the previous cycle is overridden during renewal.
BSR-01001-Oct-202531-Dec-202501-Oct-2025Pending Billing

Say, the product is renewed again but the billing rule on the billing header is updated to "Bill in Arrears". This change affects renewal on the ready-for-invoice date as follows:

BSR IDPeriod Start DatePeriod End DateReady for Invoice DateInvoice StatusRemarks
BSR-01101-Jan-202631-Mar-202601-Apr-2026Pending BillingThe ready-for-invoice date is deferred to Period End Date + 1 for bill in arrears
BSR-01201-Apr-202630-Jun-202601-Jul-2026Pending BillingThe ready-for-invoice date is deferred to Period End Date + 1 for bill in arrears
BSR-01301-Jul-202630-Sep-202601-Oct-2026Pending BillingThe ready-for-invoice date is deferred to Period End Date + 1 for bill in arrears
BSR-01401-Oct-202631-Dec-202601-Jan-2027Pending BillingThe ready-for-invoice date is deferred to Period End Date + 1 for bill in arrears

Assume the product or service is renewed again but the billing rule on the billing header is reverted to "Bill in Advance". This change affects renewal on the ready-for-invoice date as follows:

BSR IDPeriod Start DatePeriod End DateReady for Invoice DateInvoice StatusRemarks
BSR-01501-Jan-202731-Mar-202701-Jan-2027Pending BillingThe ready-for-invoice date is updated to the period start date for the bill in advance
BSR-01601-Apr-202730-Jun-202701-Apr-2027Pending BillingThe ready-for-invoice date is updated to the period start date for the bill in advance
BSR-01701-Jul-202730-Sep-202701-Jul-2027Pending BillingThe ready-for-invoice date is updated to the period start date for the bill in advance
BSR-01801-Oct-202731-Dec-202701-Oct-2027Pending BillingThe ready-for-invoice date is updated to the period start date for the bill in advance