Android Setup Guide
diff --git a/packages/docs/src/pages/docs/apis/index.tsx b/packages/docs/src/pages/docs/apis/index.tsx index 69751437..ad26903e 100644 --- a/packages/docs/src/pages/docs/apis/index.tsx +++ b/packages/docs/src/pages/docs/apis/index.tsx @@ -98,9 +98,9 @@ function APIsIndex() {
APIs
diff --git a/packages/docs/src/pages/docs/ecosystem.tsx b/packages/docs/src/pages/docs/ecosystem.tsx index 8590f12b..27c32161 100644 --- a/packages/docs/src/pages/docs/ecosystem.tsx +++ b/packages/docs/src/pages/docs/ecosystem.tsx @@ -10,8 +10,9 @@ function Ecosystem() {
Ecosystem
diff --git a/packages/docs/src/pages/docs/errors.tsx b/packages/docs/src/pages/docs/errors.tsx index 512d997f..567fdea7 100644 --- a/packages/docs/src/pages/docs/errors.tsx +++ b/packages/docs/src/pages/docs/errors.tsx @@ -12,9 +12,9 @@ function Errors() {
Error Codes
diff --git a/packages/docs/src/pages/docs/events.tsx b/packages/docs/src/pages/docs/events.tsx index bb7d4f0d..c7f7cf6c 100644 --- a/packages/docs/src/pages/docs/events.tsx +++ b/packages/docs/src/pages/docs/events.tsx @@ -12,9 +12,9 @@ function Events() {Events
diff --git a/packages/docs/src/pages/docs/horizon-setup.tsx b/packages/docs/src/pages/docs/horizon-setup.tsx index b6d8c442..96c8fcde 100644 --- a/packages/docs/src/pages/docs/horizon-setup.tsx +++ b/packages/docs/src/pages/docs/horizon-setup.tsx @@ -6,9 +6,9 @@ function HorizonSetup() {Horizon OS Setup Guide
diff --git a/packages/docs/src/pages/docs/types/index.tsx b/packages/docs/src/pages/docs/types/index.tsx index 74e392f9..03e9c464 100644 --- a/packages/docs/src/pages/docs/types/index.tsx +++ b/packages/docs/src/pages/docs/types/index.tsx @@ -231,9 +231,9 @@ function TypesIndex() {
- Unifying fragmented IAP implementations across platforms, - frameworks, and emerging technologies + Stop rewriting IAP code for every platform. One API for iOS, + Android, Vision Pro, and Meta Quest.
+ {/* Quick Stats */} +Why Developers Choose OpenIAP
++ Build revenue-generating features faster with less code +
+Learn Once
++ Master one API instead of learning different patterns for iOS, + Android, and every framework +
+Runtime Errors
++ Type-safe generated code catches mistakes at compile time, not + in production +
+Platform Features
++ Full access to StoreKit 2 and Play Billing v8 — no features + hidden or abstracted away +
+The Problem We're Solving
@@ -202,21 +256,10 @@ function Home() {- XR-Compatible{' '} - - (WIP) - -
+XR-Compatible
- Horizon OS, Android XR, Vision Pro - new realities need - purchases. OpenIAP is ready for the spatial computing era. + Horizon OS and Vision Pro supported. Android XR coming soon. + OpenIAP is ready for the spatial computing era.
Introduction to OpenIAP
- -What is OpenIAP?
-- OpenIAP is an open specification that standardizes in-app purchase - implementations across diverse platforms and frameworks. As the IAP - ecosystem becomes increasingly fragmented with new platforms - (StoreKit 2, Android Billing v8, Vision Pro, Horizon OS) and - frameworks (React Native, Flutter, KMP), OpenIAP provides a unified - specification that reduces complexity and ensures consistency. -
-Why OpenIAP
++ OpenIAP is a unified specification for in-app purchases across iOS, + Android, and XR platforms. One GraphQL schema generates type-safe + native code for Swift, Kotlin, TypeScript, Dart, and GDScript. +
+ {/* The Problem */}The Problem
-- Every new platform and framework creates its own IAP implementation. - Library maintainers independently design APIs, leading to fragmented - specifications. Developers must learn different APIs for each - platform, increasing complexity and errors. As new technologies - emerge - XR platforms, cross-platform frameworks, and emerging - payment systems - this fragmentation only grows worse. +
+ In-app purchase implementations are fragmented across platforms and + frameworks. Each library defines its own API surface, type + definitions, and event patterns. This creates several challenges:
-- In the AI coding era, this fragmentation becomes even more - problematic. AI assistants struggle to generate consistent code when - every library has different patterns, making IAP implementation - unnecessarily complex and error-prone. +
-
+
-
+ Inconsistent APIs — Method names, parameter
+ structures, and return types differ between{' '}
+
react-native-iap,flutter_inapp_purchase+ , and other libraries +
+ - + Duplicated effort — Library maintainers + independently solve the same problems (transaction handling, error + codes, subscription lifecycle) + +
- + Platform drift — When Apple adds StoreKit 2 + features or Google updates Play Billing, each library implements + changes differently + +
- + AI limitations — AI assistants cannot generate + reliable IAP code because no two libraries work the same way + +
+ New platforms like{' '} + + Vision Pro + {' '} + and Horizon OS compound this + fragmentation.
Our Solution
- -Unified APIs
-
- OpenIAP defines standard methods like initConnection(),{' '}
- fetchProducts(),requestPurchase(), and{' '}
- finishTransaction() that work consistently across all
- platforms. Library maintainers implement these standard APIs,
- ensuring developers have a consistent experience.
+
The Solution
++ OpenIAP provides a single source of truth for IAP implementations. + The specification defines:
- -Standard Events
-
- Event handling is standardized with patterns like{' '}
- purchaseUpdatedListener and
- purchaseErrorListener. No more platform-specific event
- names or handling patterns - just consistent, predictable events
- across all implementations.
-
Unified Types
-
- Common data structures like Product,{' '}
- Purchase, and PurchaseError
- are defined once and used everywhere. This ensures type safety and
- reduces the cognitive load on developers switching between
- platforms.
-
Why Now?
--
+
-
- Platform Explosion: iOS StoreKit 2, Android
- Billing v8, and new XR platforms are creating more fragmentation
- than ever
+ Unified API methods —{' '}
+
+
initConnection()+ + ,{' '} + +fetchProducts()+ + ,{' '} + +requestPurchase()+ + ,{' '} + +finishTransaction()+ -
- Framework Diversity: React Native, Flutter,
- Kotlin Multiplatform, and emerging frameworks each need IAP
- support
+ Shared type definitions —{' '}
+
+
Product+ + ,{' '} + +Purchase+ + ,{' '} + +SubscriptionPeriod+ + ,{' '} + +PurchaseError+ -
- AI Coding Era: Standardized APIs are crucial for
- AI assistants to generate reliable, consistent IAP code
+ Standard event patterns —{' '}
+
+
purchaseUpdatedListener+ + ,{' '} + +purchaseErrorListener+ - - Developer Experience: Reducing cognitive load by - providing one specification to learn instead of dozens - -
-
- Community Collaboration: Library maintainers can
- focus on implementation quality rather than API design
+ Platform-aware naming — Cross-platform types use
+ no suffix, platform-specific use
IOS/ +Androidsuffix
Who's Using OpenIAP?
-- Leading IAP libraries are already implementing the OpenIAP - specification: +
Architecture
++ OpenIAP uses a schema-driven approach. A single GraphQL schema + defines all types and operations, which are then generated into + native code for each target platform.
--
-
-
+
+ + ++ +
+
+ + View ecosystem documentation → +
+Code Generation
++ The{' '} + +
+openiap-gql+ {' '} + package contains the GraphQL schema and generators. Running{' '} +bun run generateproduces: +++ ++ {`packages/apple/Sources/Models/Types.swift # Swift types +packages/google/openiap/src/main/Types.kt # Kotlin types +src/generated/types.ts # TypeScript types +src/generated/types.dart # Dart types +src/generated/types.gd # GDScript types`} ++Native Modules
++ Two native modules implement the specification on top of platform + APIs: +
+++- react-native-iap + openiap-apple - : - {' '} - React Native & Expo implementation (Nitro Modules) - -+- - + +
-+ Swift module built on{' '} - expo-iap + StoreKit 2 - : - {' '} - React Native & Expo implementation (Expo Modules) -
- + . Supports iOS 15+, macOS 12+, visionOS 1.0+. + +
- flutter_inapp_purchase + openiap-google - : - {' '} - Flutter implementation - -+- - + +
- -+ Kotlin module built on{' '} - kmp-iap + Play Billing v8 - : - {' '} - Kotlin Multiplatform implementation -
- These libraries demonstrate that OpenIAP's unified approach works in - practice, providing consistent APIs while leveraging - platform-specific capabilities. + . Supports Android 5.0+ (API 21+). +
+ - - + +
API Design
+ +Naming Conventions
++ OpenIAP uses consistent naming across all implementations: +
+| Scope | +Pattern | +Example | +
|---|---|---|
| Cross-platform | +
+ functionName
+ |
+
+ fetchProducts(), requestPurchase()
+ |
+
| iOS-only | +
+ functionNameIOS
+ |
+
+ syncIOS(), getStorefrontIOS()
+ |
+
| Android-only | +
+ functionNameAndroid
+ |
+
+ acknowledgePurchaseAndroid()
+ |
+
Type Safety
++ Generated types ensure compile-time safety. Platform-specific fields + use suffixes to prevent accidental cross-platform usage: +
+Purchase Flow
++ The standard purchase flow works identically across all OpenIAP + implementations: +
++ See Purchase Lifecycle for + detailed flow documentation. +
+Supported Platforms
+| Platform | +Billing API | +Min Version | +
|---|---|---|
| iOS | ++ + StoreKit 2 + + | +iOS 15.0+ | +
| macOS | +StoreKit 2 | +macOS 12.0+ | +
| visionOS | +StoreKit 2 | +visionOS 1.0+ | +
| Android | ++ + Play Billing v8 + + | +API 21+ (5.0) | +
| Meta Quest | ++ Horizon OS + | +Quest 2+ | +
Framework Implementations
++ Production-ready libraries implementing the OpenIAP specification: +
+| Library | +Framework | +Bridge | +
|---|---|---|
| + + react-native-iap + + | +React Native | ++ + Nitro Modules + + | +
| + + expo-iap + + | +Expo | ++ + Expo Modules + + | +
| + + flutter_inapp_purchase + + | +Flutter | ++ + Pigeon + + | +
| + + kmp-iap + + | +Kotlin Multiplatform | ++ + K/N Interop + + | +
| + + godot-iap + + | +Godot 4.x | ++ + GDExtension + + | +
+ View all implementations → +
+Getting Started
++ Choose your framework to get started:
+Core methods and patterns
+ + + Type Definitions +Generated types for all languages
+ + + Purchase Lifecycle +Transaction flow diagrams
+ + + Tutorials +Step-by-step guides
+ +