Use this page with AI

Copy this into your coding assistant and add your request.

Read https://openiap.dev/docs/types/request-purchase-props 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]

RequestPurchaseProps

Request Types#

Types used when initiating purchases via requestPurchase().

Discriminated input to requestPurchase (type: 'in-app' | 'subs'). iOS: maps to Product.purchase(options:) (Apple docs). Android: maps to BillingClient.launchBillingFlow (Google docs).

Native references: Apple · Product.purchase(options:) · Google · BillingFlowParams

RequestPurchaseProps#

Top-level arguments for requestPurchase(). Wraps platform-specific props with a type discriminator.

Name	Type	Summary
`request`	`RequestPurchasePropsByPlatforms` \| `RequestSubscriptionPropsByPlatforms`	Platform-specific parameters matching `type`. Generated native types expose a purchase/subscription union (or separate `requestPurchase` and `requestSubscription` fields) so a subscription cannot be encoded as a one-time request.
`type`	`"in-app" \| "subs"`	Purchase type discriminator

Usage Example#

swift

// Standard in-app purchase
try await OpenIapModule.shared.requestPurchase(
    RequestPurchaseProps(
        request: .purchase(RequestPurchasePropsByPlatforms(
            apple: RequestPurchaseIosProps(sku: "premium")
        )),
        type: .inApp
    )
)

// Subscription purchase
try await OpenIapModule.shared.requestPurchase(
    RequestPurchaseProps(
        request: .subscription(RequestSubscriptionPropsByPlatforms(
            apple: RequestSubscriptionIosProps(sku: "monthly_sub")
        )),
        type: .subs
    )
)

Kotlin example

// Standard in-app purchase
openIapStore.requestPurchase(
    RequestPurchaseProps(
        request = RequestPurchaseProps.Request.Purchase(
            RequestPurchasePropsByPlatforms(
            google = RequestPurchaseAndroidProps(skus = listOf("premium"))
            )
        ),
        type = ProductQueryType.InApp
    )
)

// Subscription purchase
openIapStore.requestPurchase(
    RequestPurchaseProps(
        request = RequestPurchaseProps.Request.Subscription(
            RequestSubscriptionPropsByPlatforms(
                google = RequestSubscriptionAndroidProps(skus = listOf("monthly_sub"))
            )
        ),
        type = ProductQueryType.Subs
    )
)

TypeScript example

// Standard in-app purchase
await requestPurchase({
  request: {
    apple: { sku: 'premium' },
    google: { skus: ['premium'] }
  },
  type: 'in-app'
});

// Subscription purchase
await requestPurchase({
  request: {
    apple: { sku: 'monthly_sub' },
    google: { skus: ['monthly_sub'] }
  },
  type: 'subs'
});

Dart example

dart

// Standard in-app purchase
await FlutterInappPurchase.instance.requestPurchase(
  RequestPurchaseProps.inApp((
    apple: RequestPurchaseIosProps(sku: 'premium'),
    google: RequestPurchaseAndroidProps(skus: ['premium']),
  )),
);

// Subscription purchase
await FlutterInappPurchase.instance.requestPurchase(
  RequestPurchaseProps.subs((
    apple: RequestSubscriptionIosProps(sku: 'monthly_sub'),
    google: RequestSubscriptionAndroidProps(skus: ['monthly_sub']),
  )),
);

C# (MAUI) example

using OpenIap;
using OpenIap.Maui;

// Standard in-app purchase
await ((MutationResolver)OpenIapClient.Instance).RequestPurchaseAsync(
    new RequestPurchaseProps
    {
        RequestPurchase = new RequestPurchasePropsByPlatforms
        {
            Google = new RequestPurchaseAndroidProps
            {
                Skus = new[] { "premium" },
            },
        },
        Type = ProductQueryType.InApp,
    });

// Subscription purchase
await ((MutationResolver)OpenIapClient.Instance).RequestPurchaseAsync(
    new RequestPurchaseProps
    {
        RequestSubscription = new RequestSubscriptionPropsByPlatforms
        {
            Google = new RequestSubscriptionAndroidProps
            {
                Skus = new[] { "monthly_sub" },
            },
        },
        Type = ProductQueryType.Subs,
    });

GDScript example

# Standard in-app purchase
var props = RequestPurchaseProps.new()
props.request = RequestPurchasePropsByPlatforms.new()
props.request.apple = RequestPurchaseIosProps.new()
props.request.apple.sku = "premium"
props.request.google = RequestPurchaseAndroidProps.new()
props.request.google.skus = ["premium"]
props.type = ProductQueryType.IN_APP
await iap.request_purchase(props)

# Subscription purchase
var subs_props = RequestPurchaseProps.new()
subs_props.request_subscription = RequestSubscriptionPropsByPlatforms.new()
subs_props.request_subscription.apple = RequestSubscriptionIosProps.new()
subs_props.request_subscription.apple.sku = "monthly_sub"
subs_props.request_subscription.google = RequestSubscriptionAndroidProps.new()
subs_props.request_subscription.google.skus = ["monthly_sub"]
subs_props.type = ProductQueryType.SUBS
await iap.request_purchase(subs_props)

RequestPurchasePropsByPlatforms#

Platform-specific request structure for regular purchases (in-app).

Name	Summary
`apple`	Apple purchase parameters (RequestPurchaseIosProps)
`google`	Google purchase parameters (RequestPurchaseAndroidProps)

RequestSubscriptionPropsByPlatforms#

Platform-specific request structure for subscriptions.

Name	Summary
`apple`	Apple subscription parameters (RequestSubscriptionIosProps)
`google`	Google subscription parameters (RequestSubscriptionAndroidProps)

Platform-Specific Request Props#

RequestPurchaseIosProps#

Name	Summary
`sku`	Product identifier to purchase (required)
`andDangerouslyFinishTransactionAutomatically`	Auto-finish transaction without validation (use with caution)
`appAccountToken`	UUID linking purchase to your server's user. Must be a valid UUID format (e.g., `550e8400-e29b-41d4-a716-446655440000`). If a non-UUID value is provided, Apple will silently return `null` for this field in the purchase response.
`quantity`	Number of items to purchase
`withOffer`	Signed iOS subscription promotional offer input (`DiscountOfferInputIOS`)
`advancedCommerceData`	Attribution data token for StoreKit 2's Product.PurchaseOption.custom API. Used for campaign tokens, affiliate IDs, or other attribution data. (iOS 15+)

Android example

RequestPurchaseAndroidProps#

Name	Summary
`skus`	Array of product identifiers (required)
`offerToken`	Offer token for one-time purchase discounts (8.0+). Select an entry from `discountOffers`, then pass its `offerTokenAndroid` value here as `offerToken`.
`obfuscatedAccountId`	Obfuscated user account ID
`obfuscatedProfileId`	Obfuscated user profile ID
`isOfferPersonalized`	True if offer is personalized (EU compliance)
`developerBillingOption`	Developer billing option params for External Payments or Billing Choice. Billing Choice is available in OpenIAP 2.1.0 / openiap-google 2.3.0 and requires Play Billing 9.1.0+. In-app flows require only `billingProgram`. See DeveloperBillingOptionParamsAndroid.

Subscription Request Props#

RequestSubscriptionIosProps#

iOS subscriptions extend RequestPurchaseIosProps with these additional subscription-only fields:

Name	Summary
`winBackOffer`	Win-back offer to re-engage churned subscribers (iOS 18+).
`promotionalOfferJWS`	JWS-signed promotional offer (iOS 15+, WWDC 2025).
`billingPlanType`	StoreKit 26.4 billing plan for auto-renewable subscriptions: `monthly` for monthly billing with commitment or `up-front` for full-period payment. Omit on older OS versions and do not pass `unknown`. See SubscriptionBillingPlanTypeIOS.
`compactJWS`	Compact JWS string for overriding introductory offer eligibility (iOS 15+, WWDC 2025). Generate it on your server and omit it to let the system decide.

Android example

RequestSubscriptionAndroidProps#

Extends RequestPurchaseAndroidProps with subscription-specific fields:

Name	Summary
`purchaseToken`	Existing subscription token for upgrade/downgrade
`originalExternalTransactionId`	Original transaction ID when replacing a subscription purchased through developer billing (9.1.0+). Use this instead of `purchaseToken` for that flow.
`subscriptionOffers`	Array of offers to apply. Each contains: `sku`, `offerToken`
`subscriptionProductReplacementParams`	Item-level replacement params for subscription upgrades/downgrades (Billing Library 8.1.0+).
`developerBillingOption`	Developer billing option params for External Payments (8.3.0+) or Billing Choice (9.1.0+). See DeveloperBillingOptionParamsAndroid.