Newer Version Available

This content describes an older version of this product. View Latest

Requirements for Standalone Cancellation Order Products

Create a standalone cancellation order product through API in Salesforce Lightning or Salesforce Classic.
Available in: Salesforce Billing Winter ’21 and later

Salesforce Billing calculates canceled billings for a canceled standalone order product under the following settings.

  • The cancellation order product has a Contract Action value of Cancel.
  • The cancellation order product and related amendment order products all have a Revised Order Product field with the ID of the original order product used before any amendments or cancellations.
  • The cancellation order products and related amendment order products all have the same terminated date. The Terminated Date must be the last field you populate on each order product before you activate the cancellation order product.

You can cancel standalone order products under both legacy cancellation and LIFO cancellation.

Note

Section Title

Table 1. Product
Field Value
Billing Frequency Invoice Plan
Billing Rule [Required]
Charge Type Recurring
Revenue Recognition Rule [Required]
Tax Rule [Required]
Table 2. Order
Field Value
Account [Required]
Effective Date [Required]
Price Book [Required]
Status Draft
Field Value
Contract Action Cancel
Billing Frequency [Required]
Charge Type [Required]
Status Draft
Reference ID [Required]
Quantity [Required]
Service Date [Required]
End Date [Required]
Price Book Entry [Required]
Order [Required]
Charge Type [Required]
Billing Type [Required]
Billable Unit Price Required for invoice runs or Bill Now to pick up the order product for invoicing. We recommend calculating a value based on the formula described in Recurring Billing and Billable Unit Price.
Ordered Quantity [Required]
Default Subscription Term [Required]
Billing Rule [Get value from product]
Revenue Recognition Rule [Get value from product]
Tax Rule [Get value from product]
Revised Order Product [ID number for the original order product used before any amendments]
Terminated Date [Set to the last day that the canceled order product will be billed]
Contract [Required for LIFO Cancellation]

Example

1{
2"allOrNone" : true,
3"compositeRequest" : [{
4  "method" : "POST",
5  "url" : "/services/data/v48.0/sobjects/order",
6  "referenceId" : "refOrder",
7  "body" : { 
8      "Status" : "Draft" , 
9      "EffectiveDate" : "2020-06-16", 
10      "Pricebook2Id" : "Price records ID",
11      "AccountId" : "Account records ID"}
12  },{
13  "method" : "POST",
14  "url" : "/services/data/v48.0/sobjects/OrderItem",
15  "referenceId" : "refOrderItem",
16  "body" : { 
17    "Quantity" : "1", 
18    "Unitprice" : "1200",
19    "ServiceDate" : "2020-06-16", 
20    "EndDate" : "2021-06-15", 
21    "SBQQ__ChargeType__c" : "Recurring",
22    "SBQQ__BillingType__c" : "Advance",
23    "SBQQ__BillingFrequency__c" : "Monthly",
24    "blng__BillableUnitPrice__c" : "100",
25    "SBQQ__OrderedQuantity__c" : "1", 
26    "SBQQ__DefaultSubscriptionTerm__c" : "1", 
27    "SBQQ__Status__c" : "Draft", 
28    "PricebookEntryId" : "PricebookEntry records ID",
29    "SBQQ__RevisedOrderProduct__c" : "RevisedOrderProduct(original orderproduct) records ID",
30    "SBQQ__TerminatedDate__c" : "2020-08-15",
31    "SBQQ__ContractAction__c" : "Cancel",
32    "orderId" : "@{refOrder.id}"
33    }
34  }]
35}