Version: 6.7

Core Methods

Essential methods for implementing in-app purchases with flutter_inapp_purchase v6.7.0. All methods support both iOS and Android platforms with unified APIs.

⚠️ Platform Differences: While the API is unified, there are important differences between iOS and Android implementations. Each method documents platform-specific behavior.

Connection Management

initConnection()

Initializes the connection to the platform store.

Future<void> initConnection() async

Description: Establishes connection with the App Store (iOS) or Google Play Store (Android). Must be called before any other IAP operations.

Platform Differences:

iOS: Connects to StoreKit 2 (iOS 15+) or StoreKit 1 (fallback)
Android: Connects to Google Play Billing Client v8

Example:

try {
  await FlutterInappPurchase.instance.initConnection();
  print('IAP connection initialized successfully');
} catch (e) {
  print('Failed to initialize IAP: $e');
}

Throws: PurchaseError if connection fails or already initialized

See Also: endConnection(), Connection Lifecycle

endConnection()

Ends the connection to the platform store.

Future<void> endConnection() async

Description: Cleanly closes the store connection and frees resources. Should be called when IAP functionality is no longer needed.

Example:

try {
  await FlutterInappPurchase.instance.endConnection();
  print('IAP connection closed');
} catch (e) {
  print('Failed to close IAP connection: $e');
}

Note: Connection can be re-established by calling initConnection() again.

Product Loading

fetchProducts()

Loads product information from the store.

Future<FetchProductsResult> fetchProducts(ProductRequest params) async

Parameters:

params.skus - List of product identifiers
params.type - Optional ProductQueryType (InApp or Subs)

Returns: FetchProductsResult union. Use the helper extensions from package:flutter_inapp_purchase/flutter_inapp_purchase.dart to convert into strongly typed lists.

Example:

try {
  final result = await FlutterInappPurchase.instance.fetchProducts(
    ProductRequest(
      skus: ['product_1', 'premium_upgrade'],
      type: ProductQueryType.InApp,
    ),
  );

  final products = result.inAppProducts();
  for (final product in products) {
    print('Product: ${product.id}');
    print('Price: ${product.displayPrice}');
    print('Title: ${product.title}');
  }
} catch (e) {
  print('Failed to load products: $e');
}

Platform Differences:

iOS: Uses StoreKit 2 product APIs
Android: Uses querySkuDetails() (Billing Client)

Purchase Processing

requestPurchase()

Initiates a purchase using platform-specific request objects.

Future<void> requestPurchase({
  required RequestPurchase request,
  required PurchaseType type,
}) async

Parameters:

request - Platform-specific purchase request
type - Purchase type (PurchaseType.inapp or PurchaseType.subs)

Example:

// Create platform-specific request
final request = RequestPurchase(
  ios: RequestPurchaseIOS(
    sku: 'premium_upgrade',
    quantity: 1,
  ),
  android: RequestPurchaseAndroid(
    skus: ['premium_upgrade'],
  ),
);

try {
  await FlutterInappPurchase.instance.requestPurchase(
    request: request,
    type: PurchaseType.inapp,
  );
  // Listen to purchaseUpdated stream for result
} catch (e) {
  print('Purchase request failed: $e');
}

Platform Differences:

iOS: Single sku, supports quantity and promotional offers
Android: Array of skus, supports obfuscated user IDs

requestPurchaseWithBuilder()

Builder-based helper for configuring platform-specific purchase parameters via RequestPurchaseBuilder.

await FlutterInappPurchase.instance.requestPurchaseWithBuilder(
  build: (RequestPurchaseBuilder r) => r
    ..type = ProductType.Subs
    ..withIOS((RequestPurchaseIosBuilder i) => i..sku = 'your.sku1')
    ..withAndroid(
      (RequestPurchaseAndroidBuilder a) => a..skus = ['your.sku1'],
    ),
);

Tips:

Assign ProductType.InApp or ProductType.Subs explicitly via type.
Configure only the platforms you need; unmodified builders are ignored.
Internally this feeds into requestPurchase with the generated RequestPurchaseProps.

Transaction Management

finishTransaction()

Completes a transaction after successful purchase processing.

Future<void> finishTransaction(
  Purchase purchase, {
  bool isConsumable = false,
}) async

Parameters:

purchase - The purchase to finish
isConsumable - Whether the product is consumable (Android only)

Example:

// In your purchase success handler
FlutterInappPurchase.purchaseUpdated.listen((purchase) async {
  if (purchase != null) {
    try {
      // Deliver the product to user
      await deliverProduct(purchase.productId);

      // Finish the transaction
      await FlutterInappPurchase.instance.finishTransaction(
        purchase,
        isConsumable: true, // For consumable products
      );

      print('Transaction completed successfully');
    } catch (e) {
      print('Failed to finish transaction: $e');
    }
  }
});

Platform Behavior:

iOS: Calls finishTransaction on the transaction
Android: Calls consumePurchase (consumable) or acknowledgePurchase (non-consumable)

consumePurchaseAndroid()

Android-specific method to consume a purchase.

Future<void> consumePurchaseAndroid({
  required String purchaseToken,
}) async

Parameters:

purchaseToken - The purchase token to consume

Example:

// Android-specific consumption
if (Platform.isAndroid) {
  try {
    await FlutterInappPurchase.instance.consumePurchaseAndroid(
      purchaseToken: purchase.purchaseToken!,
    );
    print('Purchase consumed successfully');
  } catch (e) {
    print('Failed to consume purchase: $e');
  }
}

Note: Only available on Android. Use finishTransaction() for cross-platform compatibility.

Purchase History

getAvailablePurchases()

Gets available purchases and restores them with optional filtering.

Future<List<Purchase>> getAvailablePurchases([PurchaseOptions? options]) async

Parameters:

options (optional) - Control which receipts are returned on iOS and whether they are emitted through the purchase update listener.

Returns: List of available purchases

Examples:

// Default: Active purchases only
final purchases = await FlutterInappPurchase.instance.getAvailablePurchases();

// Include expired iOS subscriptions and publish to the purchaseUpdated stream
final allPurchases = await FlutterInappPurchase.instance.getAvailablePurchases(
  PurchaseOptions(
    onlyIncludeActiveItemsIOS: false,
    alsoPublishToEventListenerIOS: true,
  ),
);

try {
  final purchases = await FlutterInappPurchase.instance.getAvailablePurchases();

  print('Found ${purchases.length} available purchases');
  for (final purchase in purchases) {
    print('Product: ${purchase.productId}');
    print('Date: ${purchase.transactionDate}');
  }
} catch (e) {
  print('Failed to get available purchases: $e');
}

restorePurchases()

Restores previous purchases (primarily for iOS).

Future<void> restorePurchases() async

Example:

try {
  await FlutterInappPurchase.instance.restorePurchases();

  // Check available purchases after restoration
  final restored = await FlutterInappPurchase.instance.getAvailablePurchases();
  print('Restored ${restored.length} purchases');
} catch (e) {
  print('Failed to restore purchases: $e');
}

Platform Behavior:

iOS: Triggers App Store purchase restoration
Android: Returns cached purchase data

Platform-Specific Methods

iOS-Specific Methods

presentCodeRedemptionSheetIOS()

Presents the App Store code redemption sheet.

Future<void> presentCodeRedemptionSheetIOS() async

Example:

if (Platform.isIOS) {
  try {
    await FlutterInappPurchase.instance.presentCodeRedemptionSheetIOS();
  } catch (e) {
    print('Failed to present redemption sheet: $e');
  }
}

Requirements: iOS 14.0+

showManageSubscriptionsIOS()

Shows the subscription management interface.

Future<void> showManageSubscriptionsIOS() async

Example:

if (Platform.isIOS) {
  try {
    await FlutterInappPurchase.instance.showManageSubscriptionsIOS();
  } catch (e) {
    print('Failed to show subscription management: $e');
  }
}

Android-Specific Methods

deepLinkToSubscriptionsAndroid()

Opens the Google Play subscription management page.

Future<void> deepLinkToSubscriptionsAndroid() async

Example:

if (Platform.isAndroid) {
  try {
    await FlutterInappPurchase.instance.deepLinkToSubscriptionsAndroid();
  } catch (e) {
    print('Failed to open subscription management: $e');
  }
}

Error Handling

All core methods may throw PurchaseError exceptions. Always wrap calls in try-catch blocks:

try {
  await FlutterInappPurchase.instance.initConnection();
} on PurchaseError catch (e) {
  switch (e.code) {
    case ErrorCode.AlreadyInitialized:
      print('Already initialized');
      break;
    case ErrorCode.NetworkError:
      print('Network error - check connection');
      break;
    default:
      print('Purchase error: ${e.message}');
  }
} catch (e) {
  print('Unexpected error: $e');
}

Best Practices

1. Connection Management

class IAPManager {
  static bool _isInitialized = false;

  static Future<void> initialize() async {
    if (!_isInitialized) {
      await FlutterInappPurchase.instance.initConnection();
      _isInitialized = true;
    }
  }

  static Future<void> dispose() async {
    if (_isInitialized) {
      await FlutterInappPurchase.instance.endConnection();
      _isInitialized = false;
    }
  }
}

2. Product Loading with Caching

class ProductManager {
  static List<BaseProduct>? _cachedProducts;
  static DateTime? _lastFetch;
  static const _cacheTimeout = Duration(hours: 1);

  static Future<List<BaseProduct>> fetchInAppProducts(List<String> skus) async {
    if (_cachedProducts != null &&
        _lastFetch != null &&
        DateTime.now().difference(_lastFetch!) < _cacheTimeout) {
      return _cachedProducts!;
    }

    final result = await FlutterInappPurchase.instance.fetchProducts(
      ProductRequest(
        skus: skus,
        type: ProductQueryType.InApp,
      ),
    );
    _cachedProducts = result.inAppProducts();
    _lastFetch = DateTime.now();

    return _cachedProducts!;
  }
}

3. Purchase Flow with Error Handling

Future<void> makePurchase(String sku) async {
  try {
    final request = RequestPurchase(
      ios: RequestPurchaseIOS(sku: sku, quantity: 1),
      android: RequestPurchaseAndroid(skus: [sku]),
    );

    await FlutterInappPurchase.instance.requestPurchase(
      request: request,
      type: PurchaseType.inapp,
    );

    // Success handling happens in purchaseUpdated listener
  } on PurchaseError catch (e) {
    if (e.code == ErrorCode.UserCancelled) {
      // User cancelled - don't show error
      return;
    }

    // Show error to user
    showErrorDialog(e.message);
  }
}

Migration Notes

⚠️ Breaking Changes from v5.x:

Method Names: requestPurchase() now requires RequestPurchase object
Parameters: Platform-specific parameters moved to request objects
Error Handling: PurchaseError replaces simple string errors
Initialization: Must call initConnection() before other operations

Connection Management​

initConnection()​

endConnection()​

Product Loading​

fetchProducts()​

Purchase Processing​

requestPurchase()​

requestPurchaseWithBuilder()​

Transaction Management​

finishTransaction()​

consumePurchaseAndroid()​

Purchase History​

getAvailablePurchases()​

restorePurchases()​

Platform-Specific Methods​

iOS-Specific Methods​

presentCodeRedemptionSheetIOS()​

showManageSubscriptionsIOS()​

Android-Specific Methods​

deepLinkToSubscriptionsAndroid()​

Error Handling​

Best Practices​

1. Connection Management​

2. Product Loading with Caching​

3. Purchase Flow with Error Handling​

Migration Notes​

See Also​

Connection Management

initConnection()

endConnection()

Product Loading

fetchProducts()

Purchase Processing

requestPurchase()

requestPurchaseWithBuilder()

Transaction Management

finishTransaction()

consumePurchaseAndroid()

Purchase History

getAvailablePurchases()

restorePurchases()

Platform-Specific Methods

iOS-Specific Methods

presentCodeRedemptionSheetIOS()

showManageSubscriptionsIOS()

Android-Specific Methods

deepLinkToSubscriptionsAndroid()

Error Handling

Best Practices

1. Connection Management

2. Product Loading with Caching

3. Purchase Flow with Error Handling

Migration Notes

See Also