unassignProductInstanceFromSite( )


Developer Preview

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

Unassigns a product instance from a site.

You must pass the ID of the Wix account that the product instance belongs to in the header of the call.

The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.

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

You can assign floating product instances to sites using the Assign Product Instance to Site method.

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
instanceIdstringRequired

ID of the product instance to unassign from a site.


optionsUnassignProductInstanceFromSiteOptions
Returns
Return Type:Promise<UnassignProductInstanceFromSiteResponse>
Unassign a product instance from a site with an API key
JavaScript
Errors

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

Did this help?