Purchase Service #

A comprehensive Flutter package for handling RevenueCat in-app purchases and subscriptions with real-time status tracking and paywall integration.

Features #

• 🚀 Easy RevenueCat Integration - Simple setup and configuration
• 💳 Purchase Management - Handle purchases, restores, and offerings
• 📱 Paywall Support - Built-in RevenueCat UI paywall integration
• 🔄 Real-time Updates - Automatic subscription status tracking
• 👤 User Management - Login/logout with user ID association
• 📊 Pro Status Tracking - Smart pro user detection with live updates
• 🎯 Entitlement Checking - Check specific or any active entitlements
• 📡 Stream-based - Reactive programming with status streams

Getting Started #

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  purchase_service: ^1.0.0

Then run:

flutter pub get

RevenueCat Setup #

1. Create a RevenueCat account at revenuecat.com
2. Configure your products and entitlements in the RevenueCat dashboard
3. Get your API key from the RevenueCat dashboard

Usage #

Basic Setup #

import 'package:purchase_service/purchase_service.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final purchaseService = PurchasesService();

  @override
  void initState() {
    super.initState();
    _initializePurchases();
  }

  Future<void> _initializePurchases() async {
    try {
      await purchaseService.initialize(
        apiKey: 'your_revenuecat_api_key',
        userId: 'optional_user_id', // Optional
      );
      print('Purchase service initialized');
    } catch (e) {
      print('Error initializing purchases: $e');
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Purchase Service Demo')),
      body: Column(
        children: [
          // Your app content
        ],
      ),
    );
  }
}

Check Pro Status #

// Simple pro status check
bool isPro = purchaseService.isPro;
if (isPro) {
  print('User is pro!');
} else {
  print('User is free');
}

// Listen to pro status changes in real-time
purchaseService.proStatusStream.listen((isPro) {
  if (isPro) {
    print('User just became pro! 🎉');
    // Enable pro features
  } else {
    print('User subscription expired');
    // Disable pro features
  }
});

Present Paywall #

Future<void> showPaywall() async {
  try {
    final result = await purchaseService.presentPaywallIfNeeded(
      entitlement: 'pro', // Your entitlement ID
      showCloseButton: true,
    );

    switch (result) {
      case PaywallResult.purchased:
        print('Purchase successful!');
        break;
      case PaywallResult.restored:
        print('Purchases restored!');
        break;
      case PaywallResult.cancelled:
        print('User cancelled');
        break;
      case PaywallResult.error:
        print('Error occurred');
        break;
    }
  } catch (e) {
    print('Error presenting paywall: $e');
  }
}

Manual Purchase Flow #

Future<void> makePurchase() async {
  try {
    // Get available offerings
    final offerings = await purchaseService.getOfferings();

    if (offerings.current != null) {
      final package = offerings.current!.monthly; // or weekly, annual, etc.

      if (package != null) {
        // Make the purchase
        final customerInfo = await purchaseService.purchasePackage(package);
        print('Purchase successful! Active entitlements: ${customerInfo.entitlements.active.keys}');
      }
    }
  } catch (e) {
    print('Purchase failed: $e');
  }
}

Restore Purchases #

Future<void> restorePurchases() async {
  try {
    final customerInfo = await purchaseService.restorePurchases();
    print('Purchases restored! Active entitlements: ${customerInfo.entitlements.active.keys}');
  } catch (e) {
    print('Restore failed: $e');
  }
}

Check Specific Entitlements #

// Check if user has a specific entitlement
bool hasProAccess = purchaseService.hasActiveEntitlement('pro');

// Get all active entitlements
List<String> activeEntitlements = purchaseService.activeEntitlements;
print('Active entitlements: $activeEntitlements');

User Management #

// Login user
await purchaseService.updateUserId('user123');

// Logout user
await purchaseService.updateUserId(null);

Listen to Customer Info Changes #

purchaseService.customerInfoStream.listen((customerInfo) {
  print('Customer info updated: ${customerInfo.entitlements.active.keys}');
  // Update UI based on new customer info
});

Advanced Usage #

Complete Integration Example #

class PurchaseManager {
  final PurchasesService _purchaseService = PurchasesService();
  StreamSubscription<bool>? _proStatusSubscription;
  StreamSubscription<CustomerInfo>? _customerInfoSubscription;

  Future<void> initialize(String apiKey, {String? userId}) async {
    await _purchaseService.initialize(apiKey: apiKey, userId: userId);
    _setupListeners();
  }

  void _setupListeners() {
    // Listen to pro status changes
    _proStatusSubscription = _purchaseService.proStatusStream.listen((isPro) {
      if (isPro) {
        _enableProFeatures();
      } else {
        _disableProFeatures();
      }
    });

    // Listen to customer info changes
    _customerInfoSubscription = _purchaseService.customerInfoStream.listen((customerInfo) {
      _updateUserInterface(customerInfo);
    });
  }

  void _enableProFeatures() {
    // Enable premium features in your app
    print('Enabling pro features...');
  }

  void _disableProFeatures() {
    // Disable premium features
    print('Disabling pro features...');
  }

  void _updateUserInterface(CustomerInfo customerInfo) {
    // Update UI based on customer info
    print('Updating UI with customer info...');
  }

  bool get isPro => _purchaseService.isPro;

  Future<void> showPaywall(String entitlement) async {
    final result = await _purchaseService.presentPaywallIfNeeded(
      entitlement: entitlement,
    );
    // Handle result
  }

  void dispose() {
    _proStatusSubscription?.cancel();
    _customerInfoSubscription?.cancel();
    _purchaseService.dispose();
  }
}

API Reference #

PurchasesService #

Methods

• initialize({required String apiKey, String? userId, bool observerMode = false}) - Initialize RevenueCat SDK
• updateUserId(String? userId) - Login/logout user
• getOfferings() - Get available offerings
• purchasePackage(Package package) - Purchase a package
• restorePurchases() - Restore previous purchases
• presentPaywallIfNeeded({required String entitlement, bool showCloseButton = true}) - Show paywall
• hasActiveEntitlement(String entitlementId) - Check specific entitlement
• getCustomerInfo() - Get latest customer info
• dispose() - Clean up resources

Properties

• isPro - Boolean indicating if user has any active entitlement
• customerInfo - Current customer info
• activeEntitlements - List of active entitlement IDs
• customerInfoStream - Stream of customer info updates
• proStatusStream - Stream of pro status changes

Exported Types

• PaywallResult - Result of paywall presentation
• EntitlementInfo - Information about entitlements

Error Handling #

try {
  await purchaseService.initialize(apiKey: 'your_api_key');
} catch (e) {
  if (e.toString().contains('network')) {
    // Handle network errors
  } else if (e.toString().contains('configuration')) {
    // Handle configuration errors
  } else {
    // Handle other errors
  }
}

Testing #

The package includes comprehensive error handling and logging. For testing:

1. Use RevenueCat's sandbox environment
2. Set observerMode: true during initialization for testing
3. Use test products configured in your RevenueCat dashboard

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

License #

This project is licensed under the MIT License - see the LICENSE file for details.

Support #

If you find this package helpful, please give it a ⭐ on GitHub!

For issues and feature requests, please use the GitHub issue tracker.