See:{' '} - ReceiptValidationProps + VerifyPurchaseProps ,{' '} - ReceiptValidationResult + VerifyPurchaseResult
Verifies purchases with the appropriate validation service.
@@ -1168,6 +1172,176 @@ Future+ Verify a purchase using a specific provider like{' '} + + IAPKit + + . This method sends purchase data directly to the provider's API for + server-side validation. +
++ See:{' '} + + VerifyPurchaseWithProviderProps + + ,{' '} + + VerifyPurchaseWithProviderResult + +
++ IAPKit Purchase States: +
+-
+
-
+
entitled- User is entitled to the product +
+ -
+
pending-acknowledgment- Purchase needs acknowledgment + (Android) +
+ -
+
pending- Purchase is pending +
+ -
+
canceled- Purchase was canceled +
+ -
+
expired- Subscription has expired +
+ -
+
ready-to-consume- Consumable ready for consumption +
+ -
+
consumed- Consumable has been consumed +
+ -
+
unknown- Unknown state +
+ -
+
inauthentic- Purchase failed authenticity check +
+
ReceiptFailed
+ PurchaseVerificationFailed
ReceiptFinished
+ TransactionFinished
ReceiptFinishedFailed
+ TransactionFinishFailed
+
+
+
+
+ {{
+ ios: (
+ <>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ),
+ android: (
+ <>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ),
+ }}
+
+
+ );
+}
+
+export default Example;
diff --git a/packages/docs/src/styles/pages.css b/packages/docs/src/styles/pages.css
index a427a199..d6f7eab9 100644
--- a/packages/docs/src/styles/pages.css
+++ b/packages/docs/src/styles/pages.css
@@ -370,3 +370,93 @@
.platform-link:hover {
background: var(--primary-dark);
}
+
+/* Screenshot Card */
+.screenshot-card {
+ display: flex;
+ align-items: flex-start;
+ gap: 1.5rem;
+ margin-bottom: 2rem;
+ padding: 1.5rem;
+ background: var(--bg-secondary);
+ border: 1px solid var(--border-color);
+ border-radius: 0.75rem;
+}
+
+.screenshot-card img {
+ width: 180px;
+ height: auto;
+ flex-shrink: 0;
+ border-radius: 0.5rem;
+ border: 1px solid var(--border-color);
+ box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
+}
+
+.screenshot-card-content {
+ flex: 1;
+}
+
+.screenshot-card-content h4 {
+ margin: 0 0 0.5rem 0;
+ color: var(--text-primary);
+ font-size: 1.1rem;
+}
+
+.screenshot-card-content p {
+ margin: 0;
+ color: var(--text-secondary);
+ font-size: 0.95rem;
+ line-height: 1.6;
+}
+
+.screenshot-card-content .platform-badge {
+ display: inline-block;
+ padding: 0.2rem 0.5rem;
+ margin-bottom: 0.5rem;
+ font-size: 0.75rem;
+ font-weight: 600;
+ border-radius: 0.25rem;
+ text-transform: uppercase;
+}
+
+.screenshot-card-content .platform-badge.ios {
+ background: rgba(0, 122, 255, 0.1);
+ color: #007aff;
+}
+
+.screenshot-card-content .platform-badge.android {
+ background: rgba(61, 220, 132, 0.1);
+ color: #3ddc84;
+}
+
+:root.dark .screenshot-card {
+ background: var(--bg-secondary);
+ border-color: var(--border-color);
+}
+
+:root.dark .screenshot-card img {
+ border-color: var(--border-color);
+ box-shadow: 0 2px 8px rgba(0, 0, 0, 0.3);
+}
+
+:root.dark .screenshot-card-content .platform-badge.ios {
+ background: rgba(10, 132, 255, 0.2);
+ color: #0a84ff;
+}
+
+:root.dark .screenshot-card-content .platform-badge.android {
+ background: rgba(61, 220, 132, 0.2);
+ color: #3ddc84;
+}
+
+@media (max-width: 600px) {
+ .screenshot-card {
+ flex-direction: column;
+ align-items: center;
+ text-align: center;
+ }
+
+ .screenshot-card img {
+ width: 150px;
+ }
+}
diff --git a/packages/google/CONTRIBUTING.md b/packages/google/CONTRIBUTING.md
index 13445ac8..7773e54b 100644
--- a/packages/google/CONTRIBUTING.md
+++ b/packages/google/CONTRIBUTING.md
@@ -103,7 +103,7 @@ adb logcat | grep -E "OpenIap|Horizon"
- **OpenIap prefix for public models (Android)**
- Prefix all public model types with `OpenIap`.
- - Examples: `OpenIapProduct`, `OpenIapPurchase`, `OpenIapActiveSubscription`, `OpenIapRequestPurchaseProps`, `OpenIapProductRequest`, `OpenIapReceiptValidationProps`, `OpenIapReceiptValidationResult`.
+- Examples: `OpenIapProduct`, `OpenIapPurchase`, `OpenIapActiveSubscription`, `OpenIapRequestPurchaseProps`, `OpenIapProductRequest`, `OpenIapVerifyPurchaseProps`, `OpenIapVerifyPurchaseResult`.
- Private/internal helper types do not need the prefix.
- When renaming existing types, provide a public typealias from the old name to the new name to preserve source compatibility and migrate usages incrementally when feasible.
diff --git a/packages/google/Example/build.gradle.kts b/packages/google/Example/build.gradle.kts
index 8b961afe..963c9572 100644
--- a/packages/google/Example/build.gradle.kts
+++ b/packages/google/Example/build.gradle.kts
@@ -35,6 +35,12 @@ android {
buildConfigField("String", "HORIZON_APP_ID", "\"${appId}\"")
// Ensure placeholder exists for all variants (play included)
manifestPlaceholders["OCULUS_APP_ID"] = appId
+
+ // IAPKit API Key for purchase verification
+ val iapkitApiKey = localProperties.getProperty("iapkit.api.key")
+ ?: (project.findProperty("IAPKIT_API_KEY") as String?)
+ ?: ""
+ buildConfigField("String", "IAPKIT_API_KEY", "\"${iapkitApiKey}\"")
}
flavorDimensions += "platform"
diff --git a/packages/google/Example/src/main/java/dev/hyo/martie/screens/PurchaseFlowScreen.kt b/packages/google/Example/src/main/java/dev/hyo/martie/screens/PurchaseFlowScreen.kt
index 652714a4..6656b349 100644
--- a/packages/google/Example/src/main/java/dev/hyo/martie/screens/PurchaseFlowScreen.kt
+++ b/packages/google/Example/src/main/java/dev/hyo/martie/screens/PurchaseFlowScreen.kt
@@ -40,13 +40,24 @@ import dev.hyo.openiap.ProductType
import dev.hyo.openiap.Purchase
import dev.hyo.openiap.PurchaseAndroid
import dev.hyo.openiap.PurchaseInput
+import dev.hyo.openiap.PurchaseState
import dev.hyo.openiap.RequestPurchaseProps
import dev.hyo.openiap.RequestPurchaseAndroidProps
import dev.hyo.openiap.RequestPurchasePropsByPlatforms
import dev.hyo.openiap.RequestSubscriptionAndroidProps
import dev.hyo.openiap.RequestSubscriptionPropsByPlatforms
import dev.hyo.openiap.utils.toPurchaseInput
+import dev.hyo.openiap.RequestVerifyPurchaseWithIapkitGoogleProps
+import dev.hyo.openiap.RequestVerifyPurchaseWithIapkitProps
+import dev.hyo.openiap.utils.verifyPurchaseWithIapkit
import dev.hyo.martie.util.findActivity
+import dev.hyo.martie.BuildConfig
+
+enum class VerificationMethod(val displayName: String) {
+ None("❌ None (Skip)"),
+ Local("📱 Local (Device)"),
+ IAPKit("☁️ IAPKit (Server)")
+}
@OptIn(ExperimentalMaterial3Api::class)
@Composable
@@ -81,6 +92,19 @@ fun PurchaseFlowScreen(
var selectedPurchase by remember { mutableStateOfExample
++ OpenIAP provides example applications for both iOS and Android that + demonstrate the complete in-app purchase lifecycle. +
+ ++ Features + + # + +
+-
+
- + Purchase Flow - Buy consumable and non-consumable + products with verification options + +
- + Subscription Flow - Subscribe to auto-renewable + subscriptions with upgrade/downgrade support + +
- + My Purchases - View and restore previously + purchased items + +
- + Offer Code - Redeem promotional offer codes (iOS + only) + +
- + Alternative Billing - Test user-choice billing flow + (Android only) + +
+ Overview + + # + +
+
+ 
+
+
+
+
+ Main Screen
++ The home screen provides navigation to all example + features including Purchase Flow, Subscription Flow, My + Purchases, and platform-specific options like Offer Code + redemption. +
++ Location + + # + +
+packages/apple/Example/+
+ Build and Run + + # + +
+ +Using Xcode (Recommended)
+-
+
-
+ Open
packages/apple/Example/Martie.xcodeprojin + Xcode +
+ - + Select your development team in Signing & Capabilities + +
- + Select your target device (real device recommended for IAP + testing) + +
- Click Run (⌘R) +
Using Command Line
+{`# Build the Swift package first
+cd packages/apple
+swift build
+
+# Build and run on simulator
+cd Example
+xcodebuild -project Martie.xcodeproj \\
+ -scheme OpenIapExample \\
+ -destination 'platform=iOS Simulator,name=iPhone 16 Pro' \\
+ build
+
+# Or build for a real device (replace with your device ID)
+xcodebuild -project Martie.xcodeproj \\
+ -scheme OpenIapExample \\
+ -destination 'id=YOUR_DEVICE_UDID' \\
+ build`}
+
+
+ ⚠️ Important: For actual in-app purchase
+ testing, you must run on a real device. The iOS simulator has
+ limited StoreKit functionality.
+
+ + Testing Purchases + + # + +
+
+ 
+
+
+
+
+ Purchase Flow
++ Test purchasing consumable and non-consumable products. + Select from three verification methods: IAPKit + (server-side), Local (StoreKit verification), or None + (skip verification). +
+-
+
- + Sign in with a sandbox Apple ID at{' '} + + Settings → Developer → Sandbox Apple Account + + +
- Launch the example app +
- + Navigate to "Purchase Flow" or "Subscription Flow" screen + +
- Select a verification method (IAPKit, Local, or None) +
- Tap on a product to initiate a purchase +
+ Purchase Verification + + # + +
+The example app supports three verification methods:
+ +IAPKit (Server-Side)
+-
+
- Sends purchase data to IAPKit API for verification +
-
+ Returns
isValid: true/falseand purchase state +
+ - Recommended for production apps +
+ Note: To use IAPKit verification, get your
+ API key from{' '}
+
+ iapkit.com
+ {' '}
+ and configure it in
+
+ Info.plist:
+ {`# Copy the template
+cp OpenIapExample/Info.plist.example OpenIapExample/Info.plist
+
+# Edit Info.plist with your API key
+IAPKIT_API_KEY
+iapkit_your_api_key_here `}
+ Local
+-
+
- Verifies purchase locally using StoreKit APIs +
- Checks transaction verification status +
- Good for development and testing +
None
+-
+
- Skips verification entirely +
- Immediately finishes the transaction +
- Only for testing purchase flow UI +
+ Git Security + + # + +
+
+ The Info.plist file is automatically excluded
+ from git to protect your API key. Only the{' '}
+ Info.plist.example template is committed.
+
+ Troubleshooting + + # + +
+ +"IAPKIT_API_KEY not configured"
+-
+
-
+ Ensure
Info.plistexists in{' '} +OpenIapExample/directory +
+ -
+ Verify the file contains the
IAPKIT_API_KEYkey +
+ - Clean build folder (⇧⌘K) and rebuild +
Products Not Loading
++ See{' '} + + iOS Setup - Common Issues + +
++ Subscription Upgrade + + # + +
+
+ 
+
+
+
+
+ Subscription Flow
++ Manage auto-renewable subscriptions with upgrade/downgrade + support. When upgrading, select proration mode to control + how the billing transition is handled. +
++ My Purchases + + # + +
+
+ 
+
+
+
+
+ Available Purchases
++ View all previously purchased items and active + subscriptions. Restore purchases to recover entitlements + after reinstalling the app or switching devices. +
++ Offer Code + + # + +
+
+ 
+
+
+
+
+ Offer Code Redemption
++ Present the iOS offer code redemption sheet to let users + redeem promotional codes for subscriptions or products. + This feature uses the native StoreKit redemption UI. +
++ External Purchase + + # + +
+
+ 
+
+
+
+
+ Alternative Billing
++ Test external purchase links that redirect users to + complete purchases outside of the App Store. This + demonstrates compliance with alternative payment + requirements in supported regions. +
++ Source Code + + # + +
+ ++ Overview + + # + +
+
+ 
+
+
+
+
+ Main Screen
++ The Android version offers all core features with an + additional Alternative Billing option for testing Google + Play's user-choice billing flow. +
++ Location + + # + +
+packages/google/Example/+
+ Build and Run + + # + +
+ +Using Android Studio (Recommended)
+-
+
-
+ Open
packages/googledirectory in Android + Studio +
+ - Wait for Gradle sync to complete +
- Select "Example" from the run configurations dropdown +
- + Select your target device (real device required for IAP + testing) + +
- Click Run (▶️) +
Using Command Line
+{`# Navigate to the google package
+cd packages/google
+
+# Build the example app
+./gradlew :Example:assembleDebug
+
+# Install on connected device
+./gradlew :Example:installDebug
+
+# Or use adb directly
+adb install Example/build/outputs/apk/debug/Example-debug.apk`}
+
+
+ ⚠️ Important: For actual in-app purchase
+ testing, the app must be:
+
+ -
+
- + Installed from Google Play (internal/closed/open testing + track) + +
- + Signed with the same key as uploaded to Play Console + +
- Tested with a license tester account +
+ Testing Purchases + + # + +
+
+ 
+
+
+
+
+ Purchase Flow
++ Purchase products using Google Play Billing. The + verification dropdown lets you choose between IAPKit + server verification, local validation, or skipping + verification entirely. +
+-
+
- + Add your Google account as a license tester in{' '} + Play Console → Setup → License testing + +
- Download the app from the Play Store test track +
- + Launch the app and go to "Purchase Flow" or "Subscription + Flow" + +
- Select a verification method (IAPKit, Local, or None) +
- Tap on a product to initiate a purchase +
+ Purchase Verification + + # + +
+The example app supports three verification methods:
+ +IAPKit (Server-Side)
+-
+
- Sends purchase data to IAPKit API for verification +
-
+ Returns
isValid: true/falseand purchase state +
+ - Recommended for production apps +
+ Note: To use IAPKit verification, get your
+ API key from{' '}
+
+ iapkit.com
+ {' '}
+ and configure it in
+
+ local.properties:
+ {`# Copy the template
+cp local.properties.example local.properties
+
+# Add your API key
+iapkit.api.key=iapkit_your_api_key_here`}
+ Local
+-
+
- + Verifies purchase locally using Google Play Billing APIs + +
- Checks purchase state +
- Good for development and testing +
None
+-
+
- Skips verification entirely +
- Immediately finishes the transaction +
- Only for testing purchase flow UI +
+ How API Key is Loaded + + # + +
+
+ The API key from local.properties is injected
+ into the app via BuildConfig during the build
+ process. The Example app's build.gradle.kts{' '}
+ includes:
+
{`// In Example/build.gradle.kts
+val localProperties = Properties()
+val localPropertiesFile = rootProject.file("local.properties")
+if (localPropertiesFile.exists()) {
+ localProperties.load(localPropertiesFile.inputStream())
+}
+
+android {
+ defaultConfig {
+ buildConfigField(
+ "String",
+ "IAPKIT_API_KEY",
+ ""${'$'}{localProperties.getProperty("iapkit.api.key", "")}""
+ )
+ }
+}`}
+ + Git Security + + # + +
+
+ The local.properties file is automatically
+ excluded from git (standard Android convention). Only the{' '}
+ local.properties.example template is committed.
+
+ Troubleshooting + + # + +
+ +"IAPKit API Key not configured"
+-
+
-
+ Ensure
local.propertiesexists in{' '} +packages/google/directory +
+ -
+ Verify it contains
iapkit.api.key=your_key+
+ -
+ Clean and rebuild:{' '}
+
./gradlew clean :Example:assembleDebug+
+
Products Not Loading
++ See{' '} + + Android Setup - Common Issues + +
++ Subscription Flow + + # + +
+
+ 
+
+
+
+
+ Subscription Flow
++ Subscribe to auto-renewable subscriptions via Google Play. + View available subscription tiers and initiate new + subscriptions with selected verification options. +
++ Subscription Upgrade + + # + +
+
+ 
+
+
+
+
+ Upgrade/Downgrade
++ Upgrade or downgrade existing subscriptions with proration + mode selection. Choose how the remaining balance should be + applied to the new subscription tier. +
++ My Purchases + + # + +
+
+ 
+
+
+
+
+ Available Purchases
++ View purchased products and active subscriptions from + Google Play. Restore purchases to sync entitlements across + devices or after app reinstallation. +
++ Redeem Offer Code + + # + +
+
+ 
+
+
+
+
+ Offer Code Redemption
++ Open the Google Play redemption flow where users can enter + promo codes. The app launches the Play Store's native code + redemption interface. +
+