App Instance Object


An app instance is a specific occurrence of an app on a Wix site. When a Wix user installs an app, a unique instance is generated for that specific site. Use the instanceId to keep track of the individual data associated with each app instance.

Properties
instanceIdstring

App instance ID. Useful to keep track of the data that's associated with the specific occurence of your app installed on a Wix site.


appNamestring

App name, as you entered it in the App Dashboard.


appVersionstring

Version of your app that's installed on the Wix site.


isFreeboolean

Whether the Wix user has installed a free or paid version of your app on their site.


billingBilling

Billing information for the app instance. Available only in case {"isFree": false}.


permissionsArray <string>

List of permissions that the Wix user has granted your app. You set the list of permissions that your app requires from the Wix user in your app's Permissions page.


availablePlansArray <AvailablePlan>

Plans available to this app instance.


originInstanceIdstring

ID of the Wix site from which the instance of your app has been cloned. Available only when {"copiedFromTemplate": true}. All visual settings of the Wix site and app data are duplicated during the cloning process. Wix also notifies you in case there is any additional external functionality for the original site.


isOriginSiteTemplatebooleandeprecated

Deprecated. This parameter will be removed on March 30, 2023. Use copiedFromTemplate instead.


copiedFromTemplateboolean

Whether this app instance was created when another Wix site was cloned.


freeTrialAvailableboolean

Whether this app instance includes a free trial that hasn't started yet.

Did this help?