Commerce Subscription Renewal Price Forecast

To access this API, users must have the following licenses and permissions:

• B2B Commerce
• Revenue Lifecycle Management

Resource

1/commerce/webstores/webstoreId/subscriptions/renewal-price-forecast

Resource examples

1http://yourInstance.salesforce.com/services/data/67.0/commerce/webstores/0ZESG000002TTAL/​subscriptions/renewal-price-forecast

1http://yourInstance.salesforce.com//services/data/v67.0/commerce/webstores/0ZESG000002TTAL/​subscriptions/renewal-price-forecast?effectiveAccountId=001SG00001MZvXh

Available version

67.0

HTTP methods

POST

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
effectiveAccountId	String	ID of the account for which the request is made. If not specified, it defaults to the account ID for the context user.	Optional	67.0

Request body for POST

JSON example

Sample request using a list of subscription IDs.

1{
2  "subscriptionIds": [
3    "02iSG000001n4ujYAA",
4    "02iSG000001gomDYAQ"
5  ]
6}

Sample request using start and end dates along with subscription IDs.

1{
2  "subscriptionIds": [
3    "02iSG000001n4ujYAA",
4    "02iSG000001gomDYAQ"
5  ],
6  "startDate": "2026-03-06T00:00:00",
7  "endDate": "2027-04-05T00:00:00"
8}

Sample request using start date and term length along with subscription IDs.

1{
2  "subscriptionIds": [
3    "02iSG000001n4ujYAA",
4    "02iSG000001gomDYAQ"
5  ],
6  "startDate": "2026-03-06T00:00:00",
7  "termLength": 1,
8  "termUnit": "Month"
9}

Properties

Name	Type	Description	Required or Optional	Available Version
endDate	String	End date for the renewal. If startDate is present, then either endDate, or (termLength and termUnit), must be present.	Optional	67.0
startDate	String	Start date for the renewal. Defaults to one day after the current subscription end date.	Optional	67.0
subscriptionIds	String[]	List of subscription IDs for renewal price forecasting.	Required	67.0
termLength	Integer	Term length for the renewal. If startDate is present, then either endDate, or (termLength and termUnit), must be present.	Optional	67.0
termUnit	String	Term unit for the renewal. If startDate is present, then either endDate, or (termLength and termUnit), must be present.	Optional	67.0

Response body for POST

Commerce Subscription Renewal Price Forecast