> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: startPurchasePlanFlow()

## Article: startPurchasePlanFlow()

## Article Link: https://dev.wix.com/docs/sdk/host-modules/workspace/apps/start-purchase-plan-flow.md

## Article Content:

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

![A premium plan upgrade page](https://wixmp-833713b177cebf373f611808.wixmp.com/images/1e199f4160d03af9dd85fab5f587c443.png)

<blockquote class="important">

__Important:__ This method is only available in the Editor.

</blockquote>

## Method declaration

```ts
(args: PurchasePlanFlowRequest) => Promise<PurchasePlanResponse>
```

## Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `args` | [PurchasePlanFlowRequest](#purchaseplanflowrequest) | Request object containing app data. |

### PurchasePlanFlowRequest

| Name | Type | Description |
| ---- | ---- | ----------- |
| `appId` | string | **Required.** The ID of the app to purchase a plan for. |

## Returns

```ts
Promise<PurchasePlanFlowResponse>
```

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

```js
import { apps } from "@wix/workspace";

const myFunc = async () => {
	...
	const appId = <YOUR_APP_ID>;
	const result = await apps.startPurchasePlanFlow({ appId });
	...
};
```

## Errors

This method may return the following [error code](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-errors.md):

- `NOT_INSTALLED`: The app isn't installed on the site. Apps must be installed before they can be upgraded.