Commerce Subscription Amendment Initiation

Amendments allow you to modify the digital product quantity of an active subscription. When a customer needs quantity changes to their subscription, you can apply them through an amendment.

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

• For positive amendments, changes can be done anytime before the next billing date. By default, pricing is based on the current list price of the digital product subscription.
• For negative amendments, changes are allowed only on the next billing date. By default, pricing is based on the last transaction price of the digital product subscription.
• A renewed subscription can’t be amended before its renewal 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-amendment

Resource examples

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

1https://yourInstance.salesforce.com/services/data/67.0/commerce/webstores​/0ZExx000000005rGAA/subscriptions/actions/initiate-amendment?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

CommerceSubscriptionAmendInput

JSON example

1{
2  "amendStartDate": "2025-08-01T00:00:00.000Z",
3  "quantityChange": 50,
4  "subscriptionIds": [
5    "02ixx0000004Hb4AAE"
6  ]
7}

Properties

Name	Type	Description	Required or Optional	Available Version
amendStartDate	Date	The date when the subscription amendment takes effect. The specified date must not be in the past and cannot be later than the subscription end date.	Required	65.0
quantityChange	Double	The change in digital product quantity for the existing subscription.	Required	65.0
subscriptionIds	String[]	List of digital product subscription IDs to amend. Currently supports amending only one digital product subscription per request.	Required	65.0

Response body for POST

Commerce Subscription Amend