Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

# About the App Plans API

The App Plans API allows you to get information about all pricing plans that
a list of apps offer to users.

With the App Plans API, you can retrieve pricing information for a list of apps.

Learn more about
[setting up your app pricing](fallback::https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).

## Before you begin

It’s important to note the following points before starting to code:

+ You can retrieve pricing information for any app, not just your own. This
  means your competitors can also retrieve pricing information about your plans, if
  they have access to your app ID.
+ Prices for plans that are managed outside of Wix aren't returned in
  [List App Plans By App Id](fallback::https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/list-app-plans-by-app-id).
+ [List App Plans By App Id](fallback::https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/list-app-plans-by-app-id),
  always returns monthly prices. If your app offers yearly plans, Wix calculates
  and returns the average price per month. For yearly plans, you can get the
  full price by multiplying the returned price with 12.
+ If you want to offer more than 4 plans for your app, you need to create an
  external pricing page, and you can't use Wix's out-of-the-box pricing page.

## Terminology

+ __App Plan__: Pricing plan that describes how your app charges users. You can
  set up multiple plans for your app, with different plans offering different
  tiers of functionality. For example, you can offer a free
  plan and 3 paid plans with an increasing number of benefits. Learn more about
  [setting up your app pricing](fallback::https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).
+ __Wix pricing page__: Wix offers your app an out-of-the-box pricing page that
  displays up to 4 app plans for your app to users. Learn more about
  [setting up a pricing page](fallback::https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-a-pricing-page).

# App Plans: Sample Use Cases and Flows

This article shares some possible use cases your app could support, as well as
a sample flow that could support each use case. This can be a helpful jumping
off point as you plan your app's implementation.

## Retrieve your app's pricing plans

You could help users retrieve their app plans.

To retrieve app plans:

1. Call [List App Plans By App Id](fallback::https://dev.wix.com/docs/rest/app-management/app-billing/app-plans/list-app-plans-by-app-id).

value

StringValue

Duration of the billing cycle. Available only for `{"cycleType": "RECURRING"}`.

Type of the billing cycle.

+ `"UNKNOWN_UNIT"`:  There is no information about the billing cycle.
+ `"ONE_TIME"`:  The customer pays for unlimited usage of the app with a single payment.
+ `"RECURRING"`: The customer pays for a subscription to the app on a recurring schedule.

cycleType

Cycle

CycleType

Count of units that make up the billing cycle.

count

unit

Duration

DurationUnit

Tax rate for the given country as percentage. Returned as `0` when
`{"showPriceWithTax": false}`.

percentage

Whether you must display the total price including taxes in the given
country.

showPriceWithTax

Type of tax required in the given country.

+ `"NOT_APPLICABLE"`: The country doesn't require that you display the total price including taxes, or Wix failed to calculate the country based on the call's IP address.
+ `"VAT"`: The given country requires that you display the total price including [value-added tax (VAT)](https://en.wikipedia.org/wiki/Value-added_tax).
+ `"GST"`: The given country requires that you display the total price including [generation-skipping transfer tax (GST)](https://en.wikipedia.org/wiki/Generation-skipping_transfer_tax).

taxType

TaxSettings

TaxType

An `appPlans` object describes how you charge users for using your app.
You can set up multiple plans for a single app, with different plans giving access to
different tiers of functionality. For example, you can offer a free plan and
3 paid plans with an increasing number of benefits. Learn more about
[setting up your app pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-your-app-pricing).

App ID, as defined in the [Wix Dev Center](https://dev.wix.com/).

List of the app's pricing plans.

Min: `0` plans
Max: `50` plans

plans

AppPlans

List of your plan's benefits, as defined by you in the [Dev Center](https://dev.wix.com/).
Currently, the benefits are available only in English.

Min: `0` benefits
Max: `4` benefits
Max per benefit: 1024 characters

benefits

Name of your app's pricing plan, as defined by you in the [Dev Center](https://dev.wix.com/).

name

List of the plan's prices. Available only when the plan's prices are managed
by Wix and not externally.

Min: `0` prices
Max: `10` prices

prices

ID of your app's pricing plan, as displayed in the [Dev Center](https://dev.wix.com/).
Identical to `vendorProductId` in the
[Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).

vendorId

Plan

Information about the plan's recurring billing cycle or single payment.

Price without taxes. For yearly plans, Wix calculates and returns the
average price per month. You can get thefull price by multiplying the
returned price with 12.

Min: `0.00`
Max: 1024 characters

priceBeforeTax

Total price including taxes.

Min: `0.00`
Max: 1024 characters

totalPrice

Details about the plan's usage-based pricing.
Available only for plans with
[usage-based pricing](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/usage-based-pricing).

Price

Description of the usaged-based pricing plan, as defined in the
[Dev Center](https://dev.wix.com/).

Max: 1024 characters

customChargeDescription

Smallest possible amount that your app charges customers in usage-based
pricing. For example, the price of a single SMS message if your
app charges customers for sending text messages. Always in
[USD](https://en.wikipedia.org/wiki/United_States_dollar).

Min: `0.00`
Max: 1024 characters

minimumChargeIncrement

Recurring, monthly base fee in usaged-based pricing that your app
charges customers regardless of how much they use your app.

Min: `0.00`
Max: 1024 characters

monthlyBaseFee

UsageBasedDetails

List of app IDs to retrieve plans for.

Min: 1 app ID
Max: 100 app IDs

appIds

ListAppPlansByAppIdRequest

Retrieved app plans.

Min: 0 plans
Max: 50 plans

appPlans

3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)
format. Wix calculates the currency based on the country code that
you pass in the call's header. If you don't pass a country code in the header,
Wix calculates the currency based on the caller's IP address. Note that the
currency may not resolve properly if you call through a VPN.

currency

Currency symbol in decimal HTML entity format. For example, `&#36;` for $
(United States Dollar). Wix calculates the currency symbol based on the
country code that you pass in the call's header. If you don't pass a country
code in the header, Wix calculates the tax settings based on the caller's IP
address. Note that the currency symbol may not resolve properly if you call
through a VPN.

currencySymbol

Tax settings. Wix calculates the tax settings based on the country code that
you pass in the call's header. If you don't pass a country code in the header,
Wix calculates the tax settings based on the caller's IP address. Note that the
tax settings may not resolve properly if you call through a VPN.

ListAppPlansByAppIdResponse

Retrieves plans for the given apps.


Also returns tax settings and currency details. Wix calculates this information
based on the 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
format that you pass in the call's header. If you don't pass a country code in
the header, Wix calculates the tax settings and currency details based on the
call's IP address. Note that the tax settings and currency details may not resolve
properly if you call through a VPN.

Prices for plans that are managed outside of Wix aren't returned.

Consumers must pay for yearly and multi-yearly plans of your app every month.
For these plans this endpoint returns the price that the consumer must pay every
month and not the total price for the entire year.

<blockquote class="important">

__Important:__
The App Plans API doesn't follow any tenancy model. You don't need any
permissions to call `List App Plans by App ID`.

</blockquote>