Use this page with AI

Copy this into your coding assistant and add your request.

Read https://openiap.dev/docs/apis/get-available-purchases 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]

getAvailablePurchases

Get the user's purchases held by the store — owned non-consumables, active subscriptions, and any pending transactions not yet finished.

iOS: onlyIncludeActiveItemsIOS: true reads Transaction.currentEntitlements (active non-consumables and live subscriptions); false iterates Transaction.all, the full StoreKit 2 history including refunded and revoked entries. The default differs by layer; see Parameters. Apple docs. Android: Calls BillingClient.queryPurchasesAsync for both INAPP and SUBS and merges. Only returns purchases still owned by the user. Google docs.

Signature

swift

func getAvailablePurchases(_ options: PurchaseOptions?) async throws -> [Purchase]

Kotlin example

suspend fun getAvailablePurchases(options: PurchaseOptions? = null): List<Purchase>

TypeScript example

getAvailablePurchases(options?: PurchaseOptions): Promise<Purchase[]>

interface PurchaseOptions {
  alsoPublishToEventListenerIOS?: boolean;
  onlyIncludeActiveItemsIOS?: boolean;
}

Dart example

dart

Future<List<Purchase>> getAvailablePurchases({
  bool? alsoPublishToEventListenerIOS,
  bool? includeSuspendedAndroid,
  bool? onlyIncludeActiveItemsIOS,
});

C# (MAUI) example

Task<IReadOnlyList<Purchase>> GetAvailablePurchasesAsync(
    PurchaseOptions? options = null
);

Kotlin (KMP) example

suspend fun getAvailablePurchases(options: PurchaseOptions? = null): List<Purchase>

GDScript example

func get_available_purchases(options = null) -> Array # of Purchase

# Godot failure-aware variant:
func get_available_purchases_result(options = null) -> Dictionary
# { "success": true, "purchases": Array[Purchase] }
# { "success": false, "code": String, "error": String }

Parameters#

Pass an optional PurchaseOptions:

alsoPublishToEventListenerIOS (optional, boolean, default false) — iOS. Re-emit results on purchaseUpdatedListener.
onlyIncludeActiveItemsIOS (optional, boolean; default true in React Native, Expo, Flutter, and MAUI, false in Swift, KMP, and Godot) — iOS. true uses Transaction.currentEntitlements (active only); false uses Transaction.all. Pass it explicitly when the difference matters.
includeSuspendedAndroid (optional, boolean, default false) — Android (Billing 8.1+). Include suspended subscriptions in the result. Suspended entries (isSuspendedAndroid === true) should NOT grant entitlements — direct the user to the subscription center to resolve payment first.

Returns#

Promise<Purchase[]> — owned/available purchases held by the store.

Failure semantics#

In SDK APIs that surface failures and in Godot's result-bearing API, an empty purchase list is an authoritative store result: the store query completed and found no purchases. Native transaction verification, serialization, or bridge decoding failures reject the whole query (or return success = false) with an error such as billing-response-json-parse-error; OpenIAP does not return a partial list.

Godot keeps get_available_purchases() for compatibility, so that array-only method still maps a failure to an empty array. Code that restores purchases, grants entitlements, or clears cached ownership must call get_available_purchases_result() and check success before using purchases. Never revoke or clear entitlements after a failed query.

Example