billing

Capacitor plugin for in-app purchases (Android: Play Billing, iOS: StoreKit). The host app passes product id and type (INAPP / SUBS) on every call—the plugin is not tied to a specific SKU. (Native layers still apply fallback defaults if parameters are missing.)

The test-app/ folder contains a small Capacitor 8 sample app so you can try your own store SKUs via the UI, localStorage, .env.local (VITE_BILLING_TEST_*), or billingTestDefaults in test-app/capacitor.config.json (see test-app/README.md).

The web platform is not a real store; the plugin returns stub values there—see below.

iOS (Capacitor 8 + SPM)

From Capacitor 8 onward, the default iOS workflow uses Swift Package Manager. This plugin ships a root Package.swift so npx cap sync can link CapacitorBilling into CapApp-SPM. The native class conforms to CAPBridgedPlugin (same pattern as @capacitor/haptics and other first-party plugins).

Enable the In-App Purchase capability in Xcode for your app target.

Android setup

1. Register the plugin (legacy snippet)

Auto-discovery usually registers plugins; if you still use manual registration in MainActivity:

import de.carstenklaffke.billing.BillingPlugin;

this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
        add(BillingPlugin.class);
        }});

2. Gradle (Kotlin stdlib conflicts)

If your app hits duplicate Kotlin stdlib classes from Play Billing, add the following to your app’s android/build.gradle inside allprojects (or the equivalent in Gradle 8+), as needed:

allprojects {
    repositories {
        google()
        mavenCentral()
    }

    configurations.all {
        exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk7'
        exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk8'
    }
}

This plugin depends on Google Play Billing Library 7.x, which can pull older Kotlin stdlib artifacts. Excluding the deprecated jdk7/jdk8 artifacts avoids duplicate classes with newer Capacitor / Kotlin toolchains.

Usage:

import {BillingPlugin} from "capacitor-billing";
import {Device} from "@capacitor/device";

BillingPlugin.querySkuDetails({ product: 'YOUR_SKU', type: 'INAPP' }).then((result: any) => {
    if (result) {
        if (result.value === "web") {
            setSkuInfos("web")
        } else {
            setSkuInfos({
                price: result.price,
                price_currency_code: result.price_currency_code,
                title: result.title,
                description: result.description
            });
        }
    } else {

    }
})

Device.getInfo().then((info: any) => {
    var product = "PRODUCT_NAME";
    BillingPlugin.launchBillingFlow({
        product: product,
        type: "SUBS"
    }).then((result: any) => {
        if (info.platform === "ios") {
            return BillingPlugin.finishTransaction({transactionId: result.storeKitTransactionID}).then((response: any) => {
                ...
                }
            )
        } else {
            return BillingPlugin.sendAck({purchaseToken: result.purchaseToken}).then((response: any) => {
                ...
                }
            )
        }
    })
})

Publishing to npm (maintainers)

npm may require two-factor authentication (OTP) or a granular access token with permission to publish this package. See npm’s publish docs if npm publish returns 403 / 2FA errors.

Get a granular access token (recommended)

1. Sign in at https://www.npmjs.com → avatar → Access Tokens.
2. Generate New Token → Granular Access Token.
3. Packages: allow Read and write for capacitor-billing (or “All packages” if you prefer).
4. Enable Automation / Bypass two-factor authentication if npm prompts for it when publishing from the CLI (policy depends on your account).
5. Copy the token once shown (starts with npm_).

Use the token in this repo

1. Copy the example file: cp .npmrc.example .npmrc
2. Edit .npmrc and replace YOUR_NPM_TOKEN with your token (or use the ${NPM_TOKEN} variant from the example and export NPM_TOKEN=... before npm publish).
3. Confirm you are on the right account: npm whoami
4. Publish: npm publish (add --otp=123456 if npm still asks for 2FA on your account).

.npmrc is gitignored so tokens are not committed.