adjustProductInstanceSpecifications( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Upgrades or downgrades a product instance. For example, you can upgrade a customer's Business Unlimited Premium plan to Business VIP using this endpoint.

You must pass the ID of the Wix account that the product instance belongs to in the header of the call. The call fails, if the product instance and Wix account don't match.

The customer has immediate access to new features, while loosing access to features not included in the new service. It's up to the reseller to decide whether the adjustment affects the customer’s payment.

You can only exchange a product instance with a service of the same type. Contact the Wix B2B sales team for details about which services belong to the same type.

You must provide either a new catalogProductId or a new billingInfo object. The new billing cycle must be supported for the product. Contact the Wix B2B sales team for information about which billing cycles are supported for each product. If you adjust the billing cycle for a product instance with RECURRING payments, you must also provide billingInfo.cycleDuration.unit.

If a removed feature is a requirement for another service, that service may not be available to the customer any longer. For example, if you downgrade a Business Unlimited plan to Business Basic, the site owners won’t be able to use Pro eCommerce Features any longer.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.

Method Declaration
Copy
Method Parameters
instanceIdstringRequired

ID of the product instance to adjust.


optionsAdjustProductInstanceSpecificationsOptions
Returns
Return Type:Promise<AdjustProductInstanceSpecificationsResponse>
Was this helpful?
Yes
No