cancelPackage( )


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 all product instances included in the package and the customer immediately looses access to the canceled functionality.

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

If a canceled product instance is a requirement for another Wix service, that functionality is also no longer available to the customer. For example, if you cancel a Premium plan, a previously connected domain is automatically 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
_idstringRequired

ID of the package to cancel.


optionsCancelPackageOptions
Returns
Return Type:Promise<CancelPackageResponse>
Did this help?