About the App Instances API

The App Instances API allows to track on which Wix sites your app is installed and when a subscription for your app is modified.

With the App Instances API, you can:

  • Get notified by Wix when a site owner installs your app on their site.
  • Track data that's associated with individual app instances.
  • Receive notifications from Wix when site owners modify or cancel their subscription for your app.

For more information how to charge site owners for using your app, see the Billing API.

Before you begin

Before you begin coding, it's important to consider that site owners 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
  • Send site owners a discount code when they downgrade their plan for your app

Terminology

  • App instance: A specific occurrence of your app on a particular Wix site.
  • Paid plan: The site owners have installed a version of your app that isn't free of charge. Your app can charge a single one-time payment or on a subscription basis.
Did this help?