Qonversion Capacitor Plugin

Qonversion is the app growth system for people and agents. It collects the revenue data of your subscription app and keeps it lined up with what App Store Connect reports, so campaigns, experiments and entitlements run on the same numbers. This repository holds the Capacitor plugin: the part that runs inside your app.

Quickstart

Create a project in the dashboard and connect your stores first — nothing validates until then.

1. Install

npm install @qonversion/capacitor-plugin
npx cap sync

2. Initialize

import {Qonversion, QonversionConfigBuilder, LaunchMode} from '@qonversion/capacitor-plugin';

const config = new QonversionConfigBuilder(
  'your_project_key',
  LaunchMode.SUBSCRIPTION_MANAGEMENT,
).build();

Qonversion.initialize(config);

The project key is in the dashboard under Settings → Developer → Keys.

This is Subscription Management Mode — Qonversion owns the purchase flow. To keep your own purchase code and use Qonversion for analytics only, initialize with Analytics Mode instead.

3. Check what the user has access to

const entitlements = await Qonversion.getSharedInstance().checkEntitlements();

if (entitlements.get('premium')?.isActive) {
  // unlock premium features
}

Full walk-through, both modes and the store setup: Quick start.

iOS native dependencies

The plugin ships both a Package.swift and a podspec, so npx cap sync resolves the native dependency with whichever package manager your iOS project uses — Swift Package Manager (the default for iOS projects created with Capacitor 8) or CocoaPods. See iOS native dependencies.

CocoaPods trunk becomes read-only on December 2, 2026 — see the CocoaPods → Swift Package Manager migration guide.

Documentation

• Welcome — what the platform does and the three ways to start.
• Capacitor setup — full installation for this platform.
• Quick start — choose a mode, create a project, connect the stores.
• API reference — REST API v4.
• For agents — MCP servers, machine-readable docs, ready-made prompts.

What this SDK does

• Collects purchases and sends them to Qonversion, where they are confirmed with the store instead of being trusted from the device.
• Resolves entitlements — one answer to "is this user premium right now", the same on every device the user signs in to.
• Keeps the history — trials, conversions, renewals, cancellations, refunds, upgrades and downgrades, as events you can query, export or forward.
• Feeds Remote Configs and A/B tests — change which products, paywalls and app behaviour your users see, and run A/B tests without shipping a release.
• Feeds Apple Ads reporting — see what each campaign, ad group and keyword returns in real revenue, not only in installs.
• Renders screens built in the dashboard — paywalls and onboarding, updated without shipping a release.

What happens when something fails — the standby service, fallback files and the uptime commitment behind the platform: reliability.

For agents

An agent can integrate this SDK end to end. The companion file AGENTS.md gives it the current version, the documented method names and the rules it must not break, instead of what its training data remembers.

Read these docs as an agent. The documentation exposes an MCP server at https://documentation.qonversion.io/mcp — no account needed. Any page is available as markdown by appending .md to its URL, and llms.txt lists every page.

Work on your project data as an agent. The Qonversion MCP server at https://mcp.qonversion.io/mcp exposes the platform's resources as tools. The agent authenticates as you over OAuth 2.1, each tool is gated by its own scope, and no Qonversion key is handed to the model. Apple Ads tools need the feature on your account (404 otherwise); campaign changes additionally need the apple_ads:write scope and a team member with campaign-management permission — check get_apple_ads_connection_status.

Destructive tools and Apple Ads changes that increase spend do not fire on the first call: they return a short-lived token addressed to the human operator, and completing the action requires echoing the resource id verbatim and giving a reason, which is recorded in the audit log. Pausing an entity or lowering a value is not parked — it applies immediately. The full tool list, the per-client setup and the scopes are in MCP Server.

Have an agent integrate this SDK. Paste this into Claude Code, Cursor, Codex or any coding agent working in your app's repository:

Integrate the Qonversion SDK into this app.

Read the official documentation before writing any code. The docs expose an MCP server at https://documentation.qonversion.io/mcp — use it if you can. Otherwise fetch pages directly; any page is available as markdown by appending .md to its URL, and https://documentation.qonversion.io/llms.txt lists every page.

Steps:

1. Check with me that a Qonversion project exists and the app stores are connected — project key, App Store shared secret and App Store ID, Google Play service account key. This is step 2 of the quick start, I have to do it in the dashboard, and nothing validates until it is done. Google credentials can take up to 24 hours to start working.
2. Read https://documentation.qonversion.io/docs/quickstart.md and decide with me between Analytics Mode and Subscription Management Mode. Do not pick one silently.
3. Read the install page for this project's platform, linked from https://documentation.qonversion.io/docs/install-sdk.md, and follow its steps and method names. Take the SDK version from the latest release tag or the package registry, not from memory — the docs page can name an older one; if they disagree, tell me.
4. Install and configure the SDK. Ask me for the Qonversion project key; it is in the dashboard under Settings → Developer → Keys. Never commit it to the repository.
5. Implement the mode we chose, following the documented method names exactly.
6. Show me the diff and tell me what you could not verify against the docs.

Prefer to do it by hand? The steps are in the quick start.

Sample app

A Capacitor app that initializes the plugin, lists products, makes a purchase and reads entitlements: example/.

Requirements

	Minimum
@capacitor/core	8 (CI-tested); 7.x is allowed by peerDependencies, not tested
iOS deployment target	14.0
Android minSdkVersion	23

compileSdk 35 in android/build.gradle is only a fallback default; your app's own compileSdkVersion overrides it.

Help

Contact us via issues on GitHub or the contact form on our site.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/SuperFeature)
3. Commit your Changes. Use small commits with separate logic. (git commit -m 'Add some super feature')
4. Push to the Branch (git push origin feature/SuperFeature)
5. Open a Pull Request

License

Qonversion SDK is available under the MIT license. See LICENSE.