Early Renewal Transaction

When you renew a new-sale transaction before its end date, those transactions are called early renewal transactions. For example, a new-sale transaction starts on 01/01/2025 and ends on 12/31/2025, and you renew it to start on 12/01/2025 and end on 12/31/2026.

When a billing schedule is created for an early renewal transaction, it results in these updates.

• The cancellation date on the original billing schedule is populated.
• A billing schedule with a negative quantity is created and can be used for a refund.
• A billing schedule with a positive quantity is created for the early renewal transaction.

When you're creating a billing schedule for an early renewal transaction, make sure that you provide the mandatory values in the transactionDetails property value.

Considerations

Keep these important considerations in mind when you specify the details for early renewal transactions.

• The BillingActionType__std value for early renewal transactions must be Renew.

• When you're creating billing schedules for early renewal transactions, your input payload must have details for two transactions.

  • A transaction to cancel the existing new-sale transaction. The details of this transaction must include a negative quantity to cancel billing for the remaining period. The quantity for this transaction must be the negative equivalent of the total quantity of all the existing billing schedules associated with the same billing schedule group.
  • Another transaction that specifies the early renewal details, which must have a positive quantity.
  • The BillingActionType__std value for both these transactions must be Renew.

• The start date of the early renewal transaction must be:

  • Before the end date of the related transaction.
  • Before the maximum end date of all the existing billing schedules associated with the billing schedule group of the related transaction.
  • The same as the start date of all the existing billing schedules associated with the same billing schedule group or after it.
• The end date for the early renewal transaction must be after the maximum end date of all the existing transactions associated with the billing schedule group of the related transaction.
• For early renewal transactions, the TaxTreatmentId__std value, the BillingTreatmentId__std value, and the LegalEntityId__std value of the related transaction are considered.

JSON example

This sample includes the transaction data for an early renewal.

{
  "Transaction": [
    {
      "id": "temp71",
      "TotalPrice__std": -10,
      "Quantity__std": -1,
      "UnitPrice__std": 10,
      "StartDate__std": "2026-12-31",
      "EndDate__std": "2027-12-31",
      "TransactionId__std": "temp71",
      "BillingActionType__std": "Renew",
      "RelatedTransactionId__std": "test21"
    },
    {
      "id": "temp72",
      "TotalPrice__std": 10,
      "Quantity__std": 1,
      "UnitPrice__std": 10,
      "StartDate__std": "2026-12-31",
      "EndDate__std": "2027-12-31",
      "TransactionId__std": "temp72",
      "BillingActionType__std": "Renew",
      "RelatedTransactionId__std": "test21"
    }
  ]
}

This sample shows the request payload to create a billing schedule for an early renewal.

{
  "transactionDetails": "{\"Transaction\":[{\"id\":\"temp71\",\"TotalPrice__std\":10,\"Quantity__std\":-1,\"UnitPrice__std\":10,\"StartDate__std\":\"2026-12-31\",\"EndDate__std\":\"2027-12-31\",\"TransactionId__std\":\"temp71\",\"BillingActionType__std\":\"Renew\",\"RelatedTransactionId__std\":\"test21\"},{\"id\":\"temp72\",\"TotalPrice__std\":10,\"Quantity__std\":1,\"UnitPrice__std\":10,\"StartDate__std\":\"2026-12-31\",\"EndDate__std\":\"2027-12-31\",\"TransactionId__std\":\"temp72\",\"BillingActionType__std\":\"Renew\",\"RelatedTransactionId__std\":\"test21\"}]}",
  "transactionContextDetails": {
    "contextDefinitionName": "StandaloneBillingContext__stdctx",
    "readContextMappingName": "TransactionMapping",
    "saveContextMappingName": "BSGEntitiesMapping"
  }
}