getUrl( )


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

Call this method when initiating the purchase flow from your pricing page. The returned checkout URL redirects to Wix to complete payment.

This call succeeds only if 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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Your App
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?