> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: App Instance

# Type: App Instance Object

# Link: https://dev.wix.com/docs/api-reference/app-management/app-instance/app-instance-object.md

## Description: 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.

## Schema:

```json
 Type: App Instance Object | type: AppInstance
 Description: 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.
       - name: instanceId  | type: string | description: 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.
       - name: appName  | type: string | description: App name, as you entered it in the App Dashboard.
       - name: appVersion  | type: string | description: Version of your app that's installed on the Wix site.
           - name: value  | type: string | description: 
       - name: isFree  | type: boolean | description: Whether the Wix user has installed a free or paid version of your app on their site.
       - name: billing  | type: BillingInfo | description: Billing information for the app instance. Available only in case `{"isFree": false}`.
           - name: packageName  | type: string | description: Name of the package that the site owner has paid for.
           - name: billingCycle  | type: string | description: Interval of the billing cycle. `ONE_TIME` indicates that the Wix user has made a single upfront payment without any automatic subscription renewal. This is primarily for usage credits (for example, 5 SMS) but may occasionally apply to a one-time setup for the app.
               enum: NO_CYCLE, MONTHLY, YEARLY, ONE_TIME, TWO_YEARS, THREE_YEARS, FOUR_YEARS, FIVE_YEARS
           - name: timeStamp  | type: string | description: Date and time the Wix user purchased the app's paid plan or began their free trial. In `YYYY-MM-DDThh:mm:ss.sssZ` format.
           - name: expirationDate  | type: string | description: Date and time the app's current billing cycle ends in `YYYY-MM-DDThh:mm:ss.sssZ` format. Available only for yearly and multi-yearly plans.
           - name: autoRenewing  | type: boolean | description: Whether the app's subscription automatically renews at the end of the current billing cycle.
               - name: value  | type: boolean | description: 
           - name: invoiceId  | type: string | description: ID of the invoice for the current billing cycle.
               - name: value  | type: number | description: 
           - name: source  | type: string | description: Information about any discounts applied to the app instance's current billing cycle. If the site owners applied a developer coupon or Wix Voucher when installing the paid version of your app, this field holds the coupon's name or `“Wix discount coupon”`. Site owners may receive a Wix Voucher when upgrading their Wix subscription. If there is no discount for the current billing cycle, the field is an empty string.
           - name: freeTrialInfo  | type: FreeTrialInfo | description: Information about the free trial applied, if relevant.
               - name: status  | type: string | description: Current free trial status.
               - name: endDate  | type: string | description: When the free trial has ended. Populated only once the free trial is over.
       - name: permissions  | type: Array<string> | description: List of [permissions](https://dev.wix.com/docs/build-apps/developer-tools/developers-center/example-app-walkthrough/build-an-app.md#4-add-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.
       - name: availablePlans  | type: Array<AvailablePlan> | description: Plans available to this app instance.
           - name: packageName  | type: string | description: Package name of the available plan.
           - name: source  | type: string | description: Source of the available plan. Can be a bundle or 3rd-party app.
       - name: originInstanceId  | type: string | description: ID of the Wix site from which the instance of your app has been cloned.  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.
       - name: isOriginSiteTemplate  | type: boolean | description: __Deprecated__. This parameter will be removed on March 30, 2023. Use `copiedFromTemplate` instead.
       - name: copiedFromTemplate  | type: boolean | description: Whether this app instance was created when another Wix site was cloned.
       - name: freeTrialAvailable  | type: boolean | description: Whether this app instance includes a free trial that hasn't started yet.

```