getUrl( )

Retrieves the URL for a Wix checkout page for the specified paid plan of your app.

This call succeeds only in case you have previously set up an external pricing page in your app's dashboard.

The returned checkout URL is valid for 48 hours.

This API allows your app to manage your pricing page outside of Wix while still using the standard Wix checkout flow.

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 Your App
Read site, business, and email details
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productIdstringRequired

ID of your app's paid plan to retrieve the Wix checkout URL for. Check your app's dashboard for a list of your app's supported product IDs.

optionsGetUrlOptions
Returns
Return Type:Promise<GetUrlResponse>
Errors

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

Did this help?