chargebee_flutter 0.0.6

This is the official Software Development Kit (SDK) for Chargebee Flutter.

Flutter SDK

Chargebee's Flutter SDK enables you to build a seamless and efficient customer experience for your subscription business.

Post-installation, initialization, and authentication with the Chargebee site, this SDK will support the following process.

• Sync In-App Subscriptions with Chargebee: Integrate your App developed on Flutter with Chargebee to process and track in-app subscriptions of the Apple App Store and Google Play Store on your Chargebee account. Thus you can create a single source of truth for subscriptions across Apple, Google, and Web stores. Use this if you are selling digital goods or services or are REQUIRED to use Apple's and Google's in-app purchases as per their app review guidelines (Apple and Google). For SDK methods to work, ensure that prerequisites (Apple and Google) are configured in Chargebee.

Requirements

The following requirements must be set up before installing Chargebee's Flutter SDK.

• 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

To use Chargebee SDK in your Flutter app, follow these steps:

1. Add Chargebee as a dependency in your pubspec.yamlfile.

   dependencies: 
    chargebee_flutter: ^0.0.6
   

2. Install dependency.

   flutter pub get
   

Configuring SDK

Prerequisites Before configuring the Chargebee Flutter SDK for syncing In-App Purchases, follow these steps.

1. iOS: Integrate the Apple App Store account with your Chargebee site.
   Android: Integrate Google Play Store account with your Chargebee site.
2. iOS: On theSync Overview pageof theweb app, click View Keys and use the value of generated App ID as the SDK Key.
   Android: On the Sync Overview page of the web app, click Set up notifications and use the generated App ID value as the SDK Key.
3. On the Chargebee site, navigate to Configure Chargebee > API Keys to create a new Publishable API Key or use an existing Publishable API Key.

Note: During the publishable API key creation you must allow read-only access to plans/items otherwise this key will not work in the following snippet. Read more.

Initialize the Chargebee Flutter SDK with your Chargebee site, Publishable API Key, and SDK Keys by including the following snippets in your app delegate during app 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('${e.message}, ${e.details}');
}

Integrating In-App Purchases

This section describes how to use the SDK to integrate In-App Purchase information. For details on In-App Purchase, read more.

Get all IAP Product Identifiers from Chargebee

Every In-App Purchase subscription product that you configure in your account, can be configured in Chargebee as a Plan. Start by retrieving the IAP Product IDs from your Chargebee account using the following function.

try {
  final result = await Chargebee.retrieveProductIdentifers(queryparam);
} on PlatformException catch (e) {
  print('${e.message}, ${e.details}');
}

For example, query parameters can be passed as "limit": "100".

Get IAP Products

Retrieve the IAP Product objects with Product IDs using the following function.

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

You can present any of the above products to your users for them to purchase.

Buy or Subscribe Product

Pass the product and customer identifier to the following function when your customer chooses the product to purchase.

customerId - Optional parameter. Although this is an optional parameter, we recommend passing customerId if it is available before user subscribes on your App. Passing this parameter ensures that customerId in your database matches with the customerId in Chargebee. In case this parameter is not passed, then the customerId will be the same as the SubscriptionId created in Chargebee.

try {
  final result = await Chargebee.purchaseProduct(product, customerId);
  print("subscription id : ${result.subscriptionId}");
  print("subscription status : ${result.status}");
}  on PlatformException catch (e) {
  print('${e.message}, ${e.details}');
}

The above function will handle the purchase against Apple App Store or Google Play Store and send the in-app purchase receipt for server-side receipt verification to your Chargebee account. Use the Subscription ID returned by the above function to check for Subscription status on Chargebee and confirm the access - granted or denied.

Get Subscription Status for Existing Subscribers using Query Parameters

Use this method to check the subscription status of a subscriber who has already purchased the product.

Use query parameters - Subscription ID, Customer ID, or Status for checking the Subscription status on Chargebee and confirm the access - granted or denied.

try {
  final result = await Chargebee.retrieveSubscriptions(queryparam);
} on PlatformException catch (e) {
  print('${e.message}, ${e.details}');
}

For example, query parameters can be passed as "customer_id" : "id", "subscription_id": "id", or "status": "active".

Retrieve Entitlements of a Subscription

Use the query parameter - Subscription ID for retrieving the list of entitlements associated with the subscription.

try {
  final result = await Chargebee.retrieveEntitlements(queryparam);
} on PlatformException catch (e) {
  print('${e.message}, ${e.details}');
}

For example, query parameters can be passed as "subscriptionId": "id".

Note: Entitlements feature is available only if your Chargebee site is on Product Catalog 2.0.

Get all items

If your Chargebee site is configured to Product Catalog 2.0, use the following functions to retrieve the item list.

try {
  final result = await Chargebee.retrieveAllItems(queryparam);
} on PlatformException catch (e) {
  print('${e.message}, ${e.details}');
}

For example, query parameters can be passed as "sort_by[desc]" : "name" or "limit": "100".

Get All Plans

If your Chargebee site is configured to Product Catalog 1.0, use the relevant functions to retrieve the plan list.

try {
  final result = await Chargebee.retrieveAllPlans(queryparam);
} on PlatformException catch (e) {
  print('${e.message}, ${e.details}');
}

For example, query parameters can be passed as "sort_by[desc]" : "name" or "limit": "100".

License

Chargebee is available under the MIT license. For more information, see the LICENSE file.