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.
App instance ID. Useful to keep track of the data that's associated with the specific instance of your app installed on a Wix site.
App name, as you entered it in the App Dashboard.
Version of your app that's installed on the Wix site.
Whether the Wix user has installed a free or paid version of your app on their site.
Billing information for the app instance. Available only in case
{"isFree": false}.
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.
Plans available to this app instance.
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.
Deprecated. This parameter will be removed on March 30, 2023. Use
copiedFromTemplate instead.
Whether this app instance was created when another Wix site was cloned.
Whether this app instance includes a free trial that hasn't started yet.
Retrieves data about the instance of your app that's installed on a Wix site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app, or to check which apps made by Wix are installed on the site.
You must authenticate this method as a Wix app (REST | SDK).
To retrieve site.ownerInfo in the response, you must
have the READ SITE OWNER EMAIL permission scope in addition to
MANAGE YOUR APP.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Triggered when an instance of your app is installed on a Wix site.
Unique identifier of the app within the website.
Instance ID of the app in the original website (relevant only when this site was duplicated from another site).
Triggered when an instance of your app is uninstalled from a Wix site.
Unique identifier of the app within the website.
Triggered when a Wix user cancels a paid plan for your app. The Wix user can continue to use your app until the end of the current billing cycle.
Date and time of auto-renewal cancellation.
Current app plan.
Current payment cycle.
Supported values: UNKNOWN_CANCELLATION_TYPE_ERROR_STATE, USER_CANCEL, FAILED_PAYMENT, TRANSFER_CANCELLATION_REASON. Reason provided by app for cancellation (if relevant).
Reason provided by site owner for cancellation (if relevant).
Cancellation type.
Triggered when a Wix user upgrades or downgrades their plan for your app.
Date and time of change.
Newly purchased app plan.
Newly selected payment cycle.
Previous app plan.
Previous payment cycle.
Coupon applied to purchase (if relevant).
Invoice ID.
Triggered when a Wix user purchases a paid plan for your app.
Date and time of purchase.
Purchased app plan.
Selected payment cycle.
Plan expiration date.
Coupon applied to purchase (if relevant).
Invoice ID.