Search.../
  1. REST
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.

appName
string

App name.

appVersion
string

App version installed in this instance.

isFree
boolean

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

billing
object

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

permissions
Array<string>

Permissions included in this app's access token.

availablePlans
Array<object>

Plans available to this instance.

originInstanceId
string

This is the instance ID of a site that is being cloned. All visual settings and app data are duplicated, and the developer should be notified to take actions related to any external functionality that may have been added to the original site.

Was this helpful?

Object

json

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