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.
It’s important to note the following points before starting to code:
App ID, as defined in the app dashboard.
List of the app's pricing plans.
Min: 0
plans
Max: 50
plans
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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 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.
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
.
List of app IDs to retrieve plans for.
Min: 1 app ID Max: 100 app IDs
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.
3-letter currency code in ISO-4217 alphabetic 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 symbol in decimal HTML entity format. For example, $
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.
Retrieved app plans.
Min: 0 plans Max: 50 plans
curl -X GET \
'https://manage.wix.com/api/apps-plans/v1/apps-plans/{appIds}' \
-H 'X-Wix-Country-Code: <COUNTRY_CODE>'
{
"taxSettings": {
"showPriceWithTax": false,
"percentage": null,
"taxType": "NOT_APPLICABLE"
},
"currency": "USD",
"currencySymbol": "$",
"appPlans": [
{
"id": "b847d4b2-fc75-4d93-af40-c0ea5feab43d",
"plans": [
{
"id": "2ca49f36-146b-4b4b-9a47-b330470b61b8",
"vendorId": "single-payment",
"name": "Single payment",
"benefits": [
"First benefit",
"Second benefit",
"Third benefit",
"Fourth benefit"
],
"prices": [
{
"priceBeforeTax": "2.00",
"totalPrice": "2.34",
"billingCycle": {
"cycleType": "ONE_TIME",
"cycleDuration": null
},
"usageBaseOptions": null
}
]
},
{
"id": "9fdb4be4-1cbb-4e5d-9bb1-c9f37b2d5655",
"vendorId": "usage-based-no-base-fee",
"name": "Usage-based without base fee",
"benefits": [
"First benefit",
"Second benefit",
"Third benefit",
"Fourth benefit"
],
"prices": [
{
"priceBeforeTax": "0.0",
"totalPrice": "0.0",
"billingCycle": {
"cycleType": "RECURRING",
"cycleDuration": {
"unit": "MONTH",
"count": 12
}
},
"usageBaseOptions": {
"minimumChargeIncrement": "0.0",
"monthlyBaseFee": "0.0",
"customChargeDescription": "Flexible monthly pricing based on usage"
}
}
]
}
]
}
]
}