startPurchasePlanFlow()
Opens an app's premium plan purchase flow to upgrade the Wix user to a paid tier or higher pricing plan on the app.
For apps made by Wix, this opens the app's premium upgrade modal. For 3rd-party apps, this opens a Wix pricing page modal. For specially configured 3rd-party apps, an external payment flow opens in a new tab.
Important: This method is only available in the Editor.
Method declaration
Copy
Parameters
| Name | Type | Description |
|---|---|---|
args | PurchasePlanFlowRequest | Request object containing app data. |
PurchasePlanFlowRequest
| Name | Type | Description |
|---|---|---|
appId | string | Required. The ID of the app to purchase a plan for. |
Returns
Copy
A promise that resolves to an PurchasePlanFlowResponse indicating the result of starting the flow.
PurchasePlanFlowResponse
| Name | Type | Description |
|---|---|---|
appId | string | The ID of the app. |
status | string | Status of the purchase plan flow. Currently, the only supported value is DISPATCHED. This means the purchase flow started successfully. |
Examples
Purchase an app's premium plan
Copy
Errors
This method may return the following error code:
NOT_INSTALLED: The app isn't installed on the site. Apps must be installed before they can be upgraded.
Did this help?