- API Type: Connect REST API
- Call Type: Asynchronous
- Event: AssetRenewInitiatedEvent
Creates and activates a renewal order for a subscription asset. This request uses information in the assets and their associated orders, together with the renewal date, to create and price an order with a Renewal
action type.
You can renew bundled assets with any combination of product selling models. When you renew an asset with an evergreen product selling model, a sales transaction item with 0 quantity is created to represent the asset and maintain the bundle structure in the sales transaction.
For more information, see:
Prerequisites
Before making this request, update the following information on the asset that you’re renewing.
- Renewal Term—the number of renewal term units in the renewal term, for example, the number of months.
- Renewal Term Unit—the unit of time used to measure the renewal, for example, Months.
- Renewal Pricing Type—how to price the renewal. To renew at the same price, use Last Negotiated Price. To renew at the current list price, use List Price.
curl "https://{MyDomainName}.my.salesforce.com/services/data/v64.0/asset-management/assets/collection/actions/initiate-renewal" \
-X POST \
-H "content-type: application/json" \
-d '{
"assetIds": {
"assetIdArray": [
"02iRO0000005A1BYAU"
]
}
}'
A custom subdomain specific to a Salesforce org. For example, yourcompanyname
creates the URL https://yourcompanyname.my.salesforce.com
.
A Salesforce API version in the format vXX.X
. To get a list of available versions, make a request to /services/data
.
{
"assetIds": {
"assetIdArray": [
"02iRO0000005A1BYAU"
]
}
}
An object containing a list of asset IDs to be renewed.
{
"errors": [],
"requestIdentifier": "4083b36c-fea9-465b-bf31-79467f98e54a",
"statusURL": "/services/data/v58.0/sobjects/RevenueAsyncOperation/95Txx0000004CH6",
"success": true
}
List of errors if the API failed
[{
"errorCode": "ILLEGAL_QUERY_PARAMETER_VALUE",
"message": null
}]
The ID of the initiate renewal async request
The URL of the RevenueAsyncOperation record created to track the status of the asynchronous request.
Indicates if the API was successful or failed