Salesforce Docs Portal

Changed Connect REST API in Billing

The Create Standalone Billing Schedules API now supports simplified data exchange. Whether you are performing a price amendment or renewal, you can send high-level request details while the system manages the granular billing adjustments. You can also change billing frequencies mid-subscription, including shifts from annual to monthly terms, directly at the billing schedule group level. This enhancement handles complex proration and calculates the correct billing period amounts when pricing and billing frequencies differ.

Changed Connect REST Request Body

Standalone Billing Schedule Input

This request body has updates to the transactionDetails input JSON data. In the transaction details, specify the values by the billing action type.

Cancellation
  • TransactionId__std—Unique identifier reference to apply to the canceled billing schedule. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to cancel the billing schedule.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced to cancel the billing schedule group. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • StartDate__std—Date the cancellation takes effect.
  • BillingActionType__std—Type of action to perform. Valid value is Cancel.
  • BillingSubActionType—Type of sub action to perform. Valid value is SimplifiedCancel.
Positive or negative quantity amendment by using related transaction or billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the billing schedule with positive or negative quantity amendment. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced for a positive or negative quantity amendment. The price is calculated based on the net unit price from the related transaction.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced for a positive or negative quantity amendment. The price is calculated based on defined date range, quantity, and net unit price. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • StartDate__std—Date the positive or negative quantity amendment takes effect.
  • EndDate__std—Effective end date of the positive or negative quantity amendment.
  • Quantity__std—Quantity to reduce or add from the related transaction.
  • BillingActionType__std—Type of action to perform. Valid value is Amend.
  • BillingSubActionType—Type of sub action to perform. Valid value is QuantityAmend.
Price amendment by using related transaction or billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the billing schedule with price amendment. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to amend the price on the billing schedule.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced to amend the price on the billing schedule group. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • NetUnitPrice__std—Net unit price that must be applied.
  • UnitPrice__std—Unit price that must be applied. Specify either unit price or net unit price.
  • StartDate__std—Date the price amendment takes effect.
  • EndDate__std—Effective end date of the price amendment.
  • Quantity__std—Additional or delta quantity to add as part of price amendment.
  • BillingActionType__std—Type of action to perform. Valid value is Amend.
  • BillingSubActionType—Type of sub action to perform. Valid value is PriceAmend.
End date change by using related transaction or billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the billing schedule with end date change. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to change the end date of subscription on the billing schedule.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced to amend the price on the billing schedule group. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • StartDate__std—Date the subscription start date takes effect.
  • EndDate__std—Date the subscription end date takes effect.
  • BillingActionType__std—Type of action to perform. Valid value is Amend.
  • BillingSubActionType—Type of sub action to perform. Valid value is EndDateChange.
Delta price chance to change a subscription’s price midterm
  • TransactionId__std—Unique identifier reference to apply to the billing schedule with delta price change. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to amend the delta price on the main transaction.
  • StartDate__std—Date the delta price change takes effect.
  • TotalPrice__std—Total price for a delta price change when quantity is set to 0.
  • UnitPrice__std—Unit price for a delta unit price change.
  • Quantity__std—Quantity that you can specify along with the delta price change details.
  • BillingActionType__std—Type of action to perform. Valid value is Amend.
  • BillingSubActionType—Type of sub action to perform. Valid value is DeltaPriceAmend.
Renewal by using related transaction or billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the renewal billing schedule. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to renew the billing schedule.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced to renew the billing schedule group. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • StartDate__std—Date the renewal takes effect. Required if renewal is based on a billing schedule group ID.
  • EndDate__std—Last date the renewal remains in effect. Required if renewal is based on a billing schedule group ID.
  • Quantity__std—Quantity that you can specify with the renewal request. Required if renewal is based on a billing schedule group ID.
  • BillingActionType__std—Type of action to perform. Valid value is Renew.
  • BillingSubActionType—Type of sub action to perform. Valid value is SimplifiedRenewal.
Early renewal by using related transaction or billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the renewal billing schedule. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to renew the billing schedule early.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced to renew each billing schedule in the billing schedule group early. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • StartDate__std—Date the early renewal takes effect.
  • EndDate__std—Last date the early renewal remains in effect.
  • Quantity__std—Quantity that you can specify with the early renewal request.
  • BillingActionType__std—Type of action to perform. Valid value is Renew.
  • BillingSubActionType—Type of sub action to perform. Valid value is SimplifiedRenewal.
As-is renewal by using related transaction or billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the renewal billing schedule. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • RelatedTransactionId__std—ID of the related transaction that must be referenced to renew the billing schedule as is.
  • BillingScheduleGroupId__std—ID of the billing schedule group that must be referenced to renew each billing schedule in the billing schedule group as is. Specify either RelatedTransactionId__std or BillingScheduleGroupId__std in your request.
  • StartDate__std—Date to start the renewal.
  • EndDate__std—Date to end the renewal.
  • BillingActionType__std—Type of action to perform. Valid value is Renew.
  • BillingSubActionType—Type of sub action to perform. Valid value is AsIsRenewal.
Billing frequency update for billing schedule group
  • TransactionId__std—Unique identifier reference to apply to the billing schedule with updated billing frequency. The Reference and ReferenceItem field on a billing schedule has this value appended with a unique ID generated string.
  • BillingScheduleGroupId__std—ID of the billing schedule group to apply the updated billing frequency.
  • BillingTermUnit__std—Specifies the billing term unit for a specific billing schedule group ID.
  • StartDate__std—Specifies the date the update to the billing term unit takes effect.
  • BillingStartMonth__std—Specifies the month the update to the billing term unit takes effect. Required if billing term unit is Quarter, Semi-Annual, or Annual.
  • BillingActionType__std—Type of action to perform. Valid value is Amend.
  • BillingSubActionType—Type of sub action to perform. Valid value is BillingFrequencyChange.

See Also