Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

App Instance Object

Attributes

NAME
TYPE
DESCRIPTION
instanceId

string

App instance ID - a unique ID assigned to each app in each site.

isFree

boolean

Whether the site owner has a free version of the app (and no paid plan is found). Otherwise false

appName

string

App name.

availablePlans

Array<object>

Plans available to this instance.

appVersion

string

App version installed in this instance.

permissions

Array<string>

Permissions included in this app's access token.

billing

object

Billing info for the purchased app/plan in this site.

Was this helpful?

Object

json

1
2{
3 "instance": {
4 "appName": "MY_SHINY_APP",
5 "appVersion": "0.0.53",
6 "billing": {
7 "billingCycle": "MONTHLY",
8 "packageName": "e8f429d4-0a6a-468f-8044-87f519a53202"
9 },
10 "instanceId": "07864c16-3a6f-4dd2-9973-028705762b2c",
11 "isFree": false,
12 "permissions": [
13 "WIX_DEVELOPERS.CREATE_CHECKOUT",
14 "WIX_DEVELOPERS.MANAGE_APP_INSTANCE",
15 "WIX_DEVELOPERS.MANAGE_CHARGE"
16 ]
17 },
18 "site": {
19 "locale": "he",
20 "multilingual": {
21 "isMultiLingual": false,
22 "supportedLanguages": []
23 },
24 "paymentCurrency": "ILS",
25 "siteDisplayName": "Mysite 34",
26 "url": "https://doereg11.wixsite.com/mysite-34",
27 "description": "My awesome site is all about selling stuff"
28 }
29}