Commerce Subscription Renewal Initiation

When using this resource, keep the following considerations in mind:

• Subscription renewal takes effect after the end date of subscription. You can renew only once before the subscription term ends. After the term ends, you can renew again.
• Default pricing for renewals is based on the current list price of the digital product subscription.
• An amended subscription can’t be renewed before its amendment start date.

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

• B2B Commerce
• Revenue Lifecycle Management

Resource

1/commerce/webstores/${webstoreId}/subscriptions/actions/initiate-renewal

Resource examples

1https://yourInstance.salesforce.com/services/data/67.0/commerce/webstores​/0ZExx000000005rGAA/subscriptions/actions/initiate-renewal

1https://yourInstance.salesforce.com/services/data/67.0/commerce/webstores​/0ZExx000000005rGAA/subscriptions/actions/initiate-renewal?effectiveAccountId=001xx000003DMe9

Available version

65.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 This field is required if the buyer wants to cancel a subscription associated with a managed account other than their default account.	65.0

Request body for POST

Root XML tag

CommerceSubscriptionRenewInput

JSON example

1{
2  "renewalEndDate": "2025-12-31T23:59:59.000Z",
3  "renewalStartDate": "2025-06-01T00:00:00.000Z",
4  "renewalTermLength": 1,
5  "renewalTermUnit": "Year",
6  "subscriptionIds": [
7    "02ixx0000004Hb4AAE",
8    "02ixx0000004Hc5AAE"
9  ]
10}

Properties

Name	Type	Description	Required or Optional	Available Version
renewalEndDate	String	The date when the subscription renewal period ends. If renewalStartDate is present, you must specify either renewalEndDate or both renewalTermLength and renewalTermUnit.	Optional	65.0
renewalStartDate	String	The date when the subscription renewal period begins. Defaults to one day after the current subscription end date.	Required	65.0
renewalTermLength	Integer	The duration of the renewal term. If renewalStartDate is provided, you must specify either renewalEndDate or both renewalTermLength and renewalTermUnit.	Optional	65.0
renewalTermUnit	String	The unit of time for the renewal term. For example, days, months, or years. If renewalStartDate is present, you must specify either renewalEndDate or both renewalTermLength and renewalTermUnit.	Optional	65.0
subscriptionIds	String[]	List of digital product subscription IDs to renew. The default is 5. The maximum value is 25. The API supports renewal of one digital product subscription per request. From API version 66.0 and later, you can renew multiple subscriptions in a single request.	Required	65.0

Response body for POST

Commerce Subscription Renew