⚠️ WARNING: WORK IS STILL IN PROGRESS. NOT READY FOR PRODUCTION YET

Tauri Plugin IAP

A Tauri plugin for In-App Purchases (IAP) with support for subscriptions on iOS (StoreKit 2), Android (Google Play Billing) and Windows (Microsoft Store).

Features

• Initialize billing/store connection
• Query products and subscriptions with detailed pricing
• Purchase subscriptions with platform-specific features
• Restore previous purchases
• Get purchase history
• Check product ownership and subscription status
• Real-time purchase state updates via events
• Automatic transaction verification (iOS)
• Support for introductory offers and free trials
• Fraud prevention with obfuscated account/profile IDs (Android)
• App account token support for tracking (iOS)
• Automatic offer token selection (Android)

Platform Support

• iOS: StoreKit 2 (requires iOS 15.0+)
• Android: Google Play Billing Library v8.0.0
• Windows: Microsoft Store API (Windows 10/11)

Installation

Install the JavaScript package:

npm install @choochmeque/tauri-plugin-iap-api
# or
yarn add @choochmeque/tauri-plugin-iap-api
# or
pnpm add @choochmeque/tauri-plugin-iap-api

Add the plugin to your Tauri project's Cargo.toml:

[dependencies]
tauri-plugin-iap = "0.4"

Configure the plugin permissions in your capabilities/default.json:

{
  "permissions": [
    "iap:default"
  ]
}

Register the plugin in your Tauri app:

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_iap::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Usage

JavaScript/TypeScript

import {
  initialize,
  getProducts,
  purchase,
  restorePurchases,
  acknowledgePurchase,
  getProductStatus,
  onPurchaseUpdated,
  PurchaseState
} from 'tauri-plugin-iap-api';

// Initialize the billing client
await initialize();

// Get available products
const products = await getProducts(['subscription_id_1', 'subscription_id_2'], 'subs');

// Check if user owns a specific product
const status = await getProductStatus('subscription_id_1', 'subs');
if (status.isOwned && status.purchaseState === PurchaseState.PURCHASED) {
  console.log('User has active subscription');
  if (status.isAutoRenewing) {
    console.log('Subscription will auto-renew');
  }
}

// Purchase a subscription or in-app product
// Simple purchase (will use first available offer on Android if not specified)
const purchaseResult = await purchase('subscription_id_1', 'subs');

// With specific offer token (Android)
const purchaseResult = await purchase('subscription_id_1', 'subs', {
  offerToken: product.subscriptionOfferDetails[0].offerToken
});

// With fraud prevention (Android)
const purchaseResult = await purchase('subscription_id_1', 'subs', {
  obfuscatedAccountId: 'hashed_account_id',
  obfuscatedProfileId: 'hashed_profile_id'
});

// With app account token (iOS - must be valid UUID)
const purchaseResult = await purchase('subscription_id_1', 'subs', {
  appAccountToken: '550e8400-e29b-41d4-a716-446655440000'
});

// Restore purchases (specify product type)
const restored = await restorePurchases('subs');

// Acknowledge a purchase (Android only, iOS auto-acknowledges)
await acknowledgePurchase(purchaseResult.purchaseToken);

// Listen for purchase updates
const unlisten = onPurchaseUpdated((purchase) => {
  console.log('Purchase updated:', purchase);
});

// Stop listening
unlisten();

Platform Setup

iOS Setup

1. Configure your app in App Store Connect
2. Create subscription products with appropriate pricing
3. Add In-App Purchase capability to your app in Xcode:
   • Open your project in Xcode
   • Select your target
   • Go to "Signing & Capabilities"
   • Click "+" and add "In-App Purchase"
4. Test with sandbox accounts

Android Setup

1. Add your app to Google Play Console
2. Create subscription products in Google Play Console
3. Configure your app's billing permissions (already included in the plugin)
4. Test with test accounts or sandbox environment

Windows Setup

1. Register your app in Microsoft Partner Center
2. Create add-on products (consumables, durables, or subscriptions)
3. Associate your app with the Microsoft Store
4. Test with Windows sandbox environment

API Reference

initialize()

Initializes the billing client connection (required on Android, no-op on iOS).

getProducts(productIds: string[], productType: 'subs' | 'inapp')

Fetches product details from the store.

Returns:

• products: Array of product objects with:
  • productId: Product identifier
  • title: Display name
  • description: Product description
  • productType: Type of product
  • formattedPrice: Localized price string
  • subscriptionOfferDetails: (subscriptions only) Array of offers

purchase(productId: string, productType: 'subs' | 'inapp' = 'subs', options?: PurchaseOptions)

Initiates a purchase flow with enhanced options for fraud prevention and account management.

Parameters:

• productId: The product to purchase
• productType: Type of product ('subs' for subscriptions, 'inapp' for one-time purchases), defaults to 'subs'
• options: Optional purchase parameters:
  • offerToken: (Android) Specific offer to purchase. If not provided, uses first available offer
  • obfuscatedAccountId: (Android) Hashed account ID for fraud prevention
  • obfuscatedProfileId: (Android) Hashed profile ID for fraud prevention
  • appAccountToken: (iOS) UUID string for account tracking and fraud prevention

Returns: Purchase object with transaction details

restorePurchases(productType: 'subs' | 'inapp' = 'subs')

Queries and returns all active purchases.

Parameters:

• productType: Type of products to restore ('subs' or 'inapp'), defaults to 'subs'

getPurchaseHistory()

Returns the complete purchase history.

acknowledgePurchase(purchaseToken: string)

Acknowledges a purchase (required on Android within 3 days, no-op on iOS).

getProductStatus(productId: string, productType: 'subs' | 'inapp' = 'subs')

Checks the ownership and subscription status of a specific product.

Parameters:

• productId: The product identifier to check
• productType: Type of product ('subs' or 'inapp'), defaults to 'subs'

Returns: ProductStatus object with:

• productId: Product identifier
• isOwned: Whether the user currently owns the product
• purchaseState: Current state (PURCHASED=0, CANCELED=1, PENDING=2)
• purchaseTime: When the product was purchased (timestamp)
• expirationTime: (subscriptions only) When the subscription expires
• isAutoRenewing: (subscriptions only) Whether auto-renewal is enabled
• isAcknowledged: Whether the purchase has been acknowledged
• purchaseToken: Token for the purchase transaction

onPurchaseUpdated(callback: (purchase: Purchase) => void)

Listens for purchase state changes.

Differences Between Platforms

iOS (StoreKit 2)

• Automatic transaction verification
• No manual acknowledgment needed
• Supports introductory offers and promotional offers
• Transaction updates are automatically observed
• Requires iOS 15.0+

Android (Google Play Billing)

• Manual acknowledgment required within 3 days
• Supports multiple subscription offers per product
• Offer tokens required for subscription purchases
• More detailed pricing phase information

Windows (Microsoft Store)

• Automatic acknowledgment handled by the Store
• Supports consumables, durables, and subscriptions
• Uses SKUs for subscription offer variations

Testing

iOS

1. Use sandbox test accounts
2. Test on physical devices (subscriptions don't work well on simulators)
3. Clear purchase history in Settings > App Store > Sandbox Account

Android

1. Upload your app to internal testing track
2. Add test accounts in Google Play Console
3. Test with test payment methods

Windows

1. Use Microsoft Store sandbox environment
2. Configure test accounts in Partner Center
3. Test with Windows Dev Center test payment methods
4. Ensure app is associated with Store listing

License

MIT