revenuecat/purchases-flutter

Purpose and entry points

purchases_flutter is a Flutter plugin exposing RevenueCat subscription, purchase, entitlement, and receipt-status capabilities over native store SDKs and the RevenueCat backend. Its public Dart entry point is lib/purchases_flutter.dart; shared error and domain APIs start at lib/errors.dart and lib/models/. A companion UI package provides native paywall and customer-center views via purchases_ui_flutter/lib/purchases_ui_flutter.dart.

Core Dart API and domain contract

The main package presents a Dart-facing API, configuration, purchase parameters/results, and strongly typed wrappers for native/RevenueCat payloads. Models isolate app consumers from platform-channel map shapes and encode offerings, customer info, products, transactions, subscriptions, virtual currencies, and web redemption.

• lib/purchases_flutter.dart

• lib/models/purchases_configuration.dart

• lib/models/customer_info_wrapper.dart

Flutter-to-native purchase boundary

Dart calls are bridged through the Flutter plugin implementations into RevenueCat’s native SDK integrations. Android registers the plugin in Java; iOS/macOS package native implementations are Objective-C. This boundary owns interaction with Google Play Billing and Apple StoreKit rather than implementing store transactions in Dart.

• android/src/main/java/com/revenuecat/purchases_flutter/PurchasesFlutterPlugin.java

• ios/purchases_flutter/Sources/purchases_flutter/PurchasesFlutterPlugin.m

• macos/purchases_flutter/Sources/purchases_flutter/PurchasesFlutterPlugin.m

Web runtime path

Web is a separate implementation layer, backed by a JavaScript hybrid mapping asset. It adapts the same Dart API to browser-compatible RevenueCat functionality; it is not routed through Android/iOS platform channels.

• lib/web/purchases_flutter_web.dart

• assets/web/purchases_js_hybrid_mappings.js

Purchase and entitlement flow

Application code configures the SDK, identifies/configures a user, retrieves offerings/products, initiates a purchase or restore, then receives typed purchase/customer-info results. Native SDKs communicate with the applicable store and RevenueCat services; RevenueCat performs server-side receipt validation and returns subscription/entitlement state. Dart wrappers deserialize the result boundary for Flutter callers.

• lib/models/offering_wrapper.dart

• lib/models/purchase_params.dart

• lib/models/purchase_result.dart

Native UI package

purchases_ui_flutter is a distinct Flutter plugin layered over the core purchasing SDK. Its Dart widgets/method handlers host platform-native paywall, footer, and customer-center views; Android uses platform view factories/views, while iOS uses Swift native view wrappers. UI results and presentation configuration cross the same plugin boundary.

• purchases_ui_flutter/lib/views/paywall_view.dart

• purchases_ui_flutter/android/src/main/kotlin/com/revenuecat/purchases_ui_flutter/views/PaywallView.kt

• purchases_ui_flutter/ios/purchases_ui_flutter/Sources/purchases_ui_flutter/PurchasesUiPaywallView.swift

Runtimes, delivery, and validation clients

The repository is primarily Dart/Flutter, with Android Gradle/Java/Kotlin and Apple CocoaPods/Swift Package Manager/Objective-C/Swift host integrations. The core package is defined for pub publishing in pubspec.yaml; native package manifests support direct Apple dependency integration. api_tester is a Flutter executable that exercises the exposed API surface, while Maestro runs end-to-end purchase-through-paywall validation against a dedicated test app.

• pubspec.yaml

• api_tester/lib/main.dart

• e2e-tests/maestro/e2e_tests/purchase_through_paywall.yaml