About the App Instances API

The App Instances API allows you to collect data about the Wix sites that have installed your app and when a subscription for your app is modified.

With the App Instances API, you can:

• Get notified by Wix when a Wix user installs your app on their site.
• Track data that's associated with individual app instances. For example, to check whether the Wix user has installed a free or paid version of your app, or to check what apps made by Wix are installed on the site.
• Receive notifications from Wix when Wix users modify or cancel their subscription for your app.

See the Billing API for more information how to charge Wix users for using your app.

Before you begin

It’s important to note the following points before starting to code:

• You must authenticate as a Wix App.
• Wix users can install only a single version of your app on their site. For example, they can't install a free and paid version of your app at the same time.

Example use cases

• Reach out to new users
• Identify a site's installed apps made by Wix

Terminology

• App instance: Specific occurrence of your app on a particular Wix site.
• Paid plan: A version of your app that isn't free. This version could require a single one-time payment or a subscription based payment.