App Instance Object


An app instance is a specific occurrence of your app on a particular Wix site. When a site owner installs your 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

ID of the app instance. You can use it to keep track of the individual data that's associated with the specific occurence of your app that's installed on a Wix site.


appNamestring

App name, as set by you in the Customs Apps page during the app creation process.


appVersionstring

Version of your app that's installed on the Wix site, as set by you during the app creation process.


isFreeboolean

Whether the site owners have 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 site owners have granted your app. You set the list of permissions that your app requires from the site owners in your app's Permissions page during the app creation process.


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 in case {"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 the app instance was created when another Wix site was cloned.


freeTrialAvailableboolean

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

Did this help?