cancelProductInstance( )


Developer Preview

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

Cancels a product instance.

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 immediately looses access to features included in the canceled service. It's up to the reseller to decide whether the adjustment affects the customer’s payment.

If a canceled service is a requirement for another service, that service may not be available to the customer any longer. For example, if you cancel a Combo Plan plan, a previously connected domain is disconnected from the site.

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 cancel.


optionsCancelProductInstanceOptions
Returns
Return Type:Promise<CancelProductInstanceResponse>
Was this helpful?
Yes
No