Use this page with AI
Copy this into your coding assistant and add your request.
Read https://openiap.dev/docs/types 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]Types
Complete type reference for OpenIAP. Each type below has its own page with field definitions, examples, and related links.
Common#
| Type | Description |
|---|---|
Product | Base product type with platform-specific extensions. |
ProductSubscription | Subscription product with billing periods and offers. |
Storefront | Store region info from getStorefront(). |
Purchase | Transaction record from a successful purchase. |
ActiveSubscription | Active subscription with renewal status. |
ProductRequest | Input for fetchProducts (skus + type). |
RequestPurchaseProps | Discriminated union for one-time purchases or subscriptions. |
PurchaseUpdatedListenerOptions | Options for purchase update listener replay behavior. |
DiscountOffer | Standardized Android one-time product offer details. |
SubscriptionOffer | Cross-platform subscription offer details. |
Validation#
| Type | Description |
|---|---|
VerifyPurchase Types | VerifyPurchaseProps and VerifyPurchaseResult definitions. |
VerifyPurchaseWithProviderProps | Provider-based verification input (e.g., IAPKit). |
VerifyPurchaseWithProviderResult | Provider-based verification response. |
IapkitProductClientPayload | Public TOML, JSON, or text data attached to an IAPKit product. |
Alternative Billing#
| Type | Description |
|---|---|
Billing Configuration | InitConnectionConfig and current billing-program options. |
Billing Programs | Google Play Billing Programs API types (8.2.0+). |
External Purchase Link | iOS external purchase link result types. |
iOS Specific#
| Type | Description |
|---|---|
SubscriptionPeriodIOS | iOS subscription period units (Day/Week/Month/Year). |
Subscription Billing Plans | StoreKit 26.4 billing plan and commitment types for iOS subscriptions. |
PaymentModeIOS | iOS payment modes for promotional offers. |
SubscriptionStatusIOS | StoreKit 2 subscription status values. |
AppTransaction | iOS 16+ app transaction info. |
RenewalInfoIOS | StoreKit 2 subscription renewal details — auto-renew intent, billing-retry state, price-increase responses, JWS payload. |
Android Specific#
| Type | Description |
|---|---|
PricingPhaseAndroid | Android pricing phases (intro / paid / free trial). |