Get Renewable Assets Summary Action

Retrieve details about renewable assets in a given order. You can use this information to create renewal opportunities.

This action gets pricing data from the OrderEntitiesMapping context mapping within the SalesTransactionContext context definition. Before you use this action, edit the context mapping to map the objects and fields used in your pricing procedure to the nodes and attributes in the context definition.

This action doesn’t support providing a summary with procedure plans. As a result, renewal line items may return a price of zero.

We recommend adding the same fields and mappings for the Quote and Order objects, and for the Quote Line Item and Order Product objects.

Note

This action is available in API version 64.0 and later.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/getRenewableAssetsSummary

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`orderId`	id	Required. ID of the order related to the assets to check for renewal opportunities.

Outputs

Output	Type	Description
`renewableAssetsSummary`	Apex-defined	Summary of the assets associated with the order, including details about renewal opportunities such as renewal pricing information. See renew_assets_summary Apex Namespace.

Example

POST

Here’s a sample request for the Get Renewable Assets Summary action.

1{
2  "inputs": [
3    {
4      "orderId": "801xx000003GZ39AAG"
5    }
6  ]
7}

Here’s a sample response for the Get Renewable Assets Summary action.

1[
2  {
3    "actionName": "getRenewableAssetsSummary",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "renewableAssetsSummary": [
10        {
11          "startDate": "2025-07-22",
12          "rootAssetOpportunity": null,
13          "renewalPriceDetails": [
14            {
15              "quantity": 1,
16              "netUnitPrice": 0
17            }
18          ],
19          "productId": "01txx0000006i3DAAQ",
20          "priceBookId": "01sxx0000005ptpAAA",
21          "priceBookEntryId": "01uxx0000008yXCAAY",
22          "orderItem": "802xx000001nb1LAAQ",
23          "opportunityProductId": null,
24          "lastAssetActionSubtype": null,
25          "lastAssetAction": "Initial Sale",
26          "endDate": "2025-08-21",
27          "assetId": "02ixx0000004HKwAAM",
28          "account": "001xx000003GZ1XAAW"
29        }
30      ]
31    },
32    "sortOrder": -1,
33    "version": 1
34  }
35]