Use this page with AI
Copy this into your coding assistant and add your request.
Read https://openiap.dev/docs/setup and https://openiap.dev/llms.txt. Follow the reading instructions, detailed reference, and linked guides relevant to my task before making changes.
Inspect my existing project and reuse its framework and conventions. Ask me for missing product decisions. Implement the requested behavior and run the applicable checks.
Show the working result, the commands and actual test results, and any remaining limitations. Keep your explanation brief.
My request: [describe what customers should be able to do]Framework Setup
Choose your app’s framework for install commands and working code. To have an assistant handle setup, build with AI.
Supported Frameworks#
| Framework | Language | Description |
|---|---|---|
| Expo | TypeScript | Expo SDK projects via Expo Modules. Same API surface as react-native-iap, including the `useIAP` hook, with managed-workflow-friendly install. Recommended for any Expo app. |
| React Native | TypeScript | Bare React Native CLI projects (RN 0.79+). Built on Nitro Modules with the `useIAP` hook, error normalization, and full StoreKit 2 / Play Billing 9.1 coverage. |
| Flutter | Dart | Flutter apps via the `flutter_inapp_purchase` package. Generated `types.dart`, sealed-class results, and a Stream-based event API that mirrors the OpenIAP schema. |
| Kotlin Multiplatform | Kotlin | KMP / Compose Multiplatform via the `kmp-iap` library. Flow-based API on top of OpenIAP, with CocoaPods integration for iOS targets and shared business logic across platforms. |
| .NET MAUI | C# | .NET MAUI / C# 12 via the `maui-iap` library (OpenIap.Maui on NuGet). Ships as one NuGet package with generated `Types.cs`, flattened Android AAR bindings, and StoreKit xcframework resources for iOS / macCatalyst. |
| Godot | GDScript | Godot 4.x via the `godot-iap` plugin (iOS GDExtension + Android AAR). Exposes the same OpenIAP function set so the same purchase flow can ship across mobile + console targets. |
Before You Start#
Complete your store’s setup before testing purchases:
- iOS Setup — App Store Connect agreement, capabilities, sandbox testers
- Android Setup — Play Console account, license testers, test track
- Store Setup — Horizon OS, Fire OS, Vega OS, and alternative marketplace targets
API and implementation references
Shared references#
- API Reference — every function, organized by symbol
- Type Definitions — every type with field tables and cross-links
- Events & Listeners — purchase / error / promoted-product event patterns
- Validation — server verification, IAPKit integration
- Error Handling — unified
PurchaseErrorshape and error codes