Flutter SDK for Chargebee: Managing Subscriptions and Payments

Chargebee’s Flutter SDK enables seamless integration of subscription management and in-app purchases with your app. This guide will walk you through setting up the chargebee_flutter plugin, configuring it, and using its various methods to handle subscriptions and payments.

Requirements

Before integrating the Chargebee Flutter SDK, ensure your environment meets these requirements:

• Flutter version 2.10.0 and above
• Dart SDK version 2.16.2 and above
• Android Gradle Plugin 4.0.0
• Gradle 6.1.1+
• AndroidX
• Java 8+ and Kotlin
• iOS 12+
• Swift 5+

Installation

Step 1: Add Dependency

Add the chargebee_flutter dependency in your pubspec.yaml file:

dependencies: 
  chargebee_flutter: ^0.4.6

Step 2: Install Dependencies

Run the following command to install the dependencies:

flutter pub get

Configuring the SDK

Prerequisites

1. iOS: Integrate your Apple App Store account with your Chargebee site. Android: Integrate your Google Play Store account with your Chargebee site.

2. Retrieve the App ID from the Sync Overview page on the Chargebee web app and use it as the SDK Key.

3. Create or use an existing Publishable API Key in Chargebee.

Initialize the SDK

Initialize the Chargebee Flutter SDK in your app delegate during startup:

import 'package:chargebee_flutter/chargebee_flutter.dart';

try {
  await Chargebee.configure("SITE_NAME", "API-KEY", "iOS SDK Key", "Android SDK Key");
} on PlatformException catch (e) {
  print('Error Message: ${e.message}, Error Details: ${e.details}, Error Code: ${e.code}');
}

Integrating In-App Purchases

Get All IAP Product Identifiers

Retrieve product identifiers from Chargebee:

try {
  final result = await Chargebee.retrieveProductIdentifiers({"limit": "100"});
} on PlatformException catch (e) {
  print('Error Message: ${e.message}, Error Details: ${e.details}, Error Code: ${e.code}');
}

Get IAP Products

Retrieve products by their IDs:

try {
  List<Product> products = await Chargebee.retrieveProducts({"productList": "[Product ID's from Google or Apple]"});
} on PlatformException catch (e) {
  print('Error Message: ${e.message}, Error Details: ${e.details}, Error Code: ${e.code}');
}

Buy or Subscribe to a Product

Handle the purchase process:

try {
  final customer = CBCustomer('customerId','firstName','lastName','emailId');
  final result = await Chargebee.purchaseStoreProduct(product, customer: customer);
  print("subscription id : ${result.subscriptionId}");
  print("subscription status : ${result.status}");
} on PlatformException catch (e) {
  print('Error Message: ${e.message}, Error Details: ${e.details}, Error Code: ${e.code}');
}

Restore Purchases

Allow users to restore previous purchases:

try {
  final result = await Chargebee.restorePurchases(true);
  print("result : $result");
} on PlatformException catch (e) {
  print('Error Message: ${e.message}, Error Details: ${e.details}, Error Code: ${e.code}');
}

Example Demo

Here is a simplified example demonstrating key functionalities:

import 'package:flutter/material.dart';
import 'package:chargebee_flutter/chargebee_flutter.dart';

void main() => runApp(MyApp());

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

class HomeScreen extends StatefulWidget {
  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {

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

  Future<void> initializeChargebee() async {
    try {
      await Chargebee.configure("your-site-name", "your-api-key", "iOS SDK Key", "Android SDK Key");
      print("Chargebee initialized successfully.");
    } on PlatformException catch (e) {
      print('Error initializing Chargebee: ${e.message}');
    }
  }

  Future<void> fetchProducts() async {
    try {
      final products = await Chargebee.retrieveProducts(["product_id_1", "product_id_2"]);
      print("Fetched Products: $products");
    } on PlatformException catch (e) {
      print('Error fetching products: ${e.message}');
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Chargebee Example')),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            fetchProducts();
          },
          child: Text('Fetch Products'),
        ),
      ),
    );
  }
}

This example demonstrates how to initialize the Chargebee SDK and fetch product information. You can expand this demo to include other functionalities like purchasing and restoring subscriptions based on your needs.

For more detailed examples and advanced configurations, refer to the official documentation.