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

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Reseller Packages
SCOPE.ACCOUNT.BASIC_TEAM_MEMBER
SCOPE.ACCOUNT.OWNER
Manage Billing
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

ID of the package to cancel.

optionsCancelPackageOptions
Returns
Return Type:Promise<CancelPackageResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?