This is the official Software Development Kit (SDK) for Chargebee iOS. This SDK makes it efficient and comfortable to build an impressive subscription experience in your iOS app.

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

• Sync In-App Subscriptions with Chargebee: Integrate with Apple Store Connect to process in-app purchase subscriptions, and track them on your Chargebee account for a single source of truth for subscriptions across the Web and Apple App Store. Use this if you are selling digital goods or services, or are REQUIRED to use Apple's in-app purchases as per their app review guidelines. For SDK methods to work, ensure that prerequisites are configured in Chargebee. To import products configured in Apple App Store and existing subscriptions, read more.

• Tokenisation of credit card: Tokenize credit card information while presenting your own user interface. Use this if you are selling physical goods or offline services or are NOT REQUIRED to use Apple's in-app purchases as per their app review guidelines.

The following requirements must be set up prior to installing Chargebee's iOS SDK

• iOS 12+

• Swift 5+

Choose from the following options to install Chargeee iOS SDK.

Add the following snippet to the Podfile to install directly from Github.

pod 'Chargebee', :git => 'https://github.com/chargebee/chargebee-ios', :tag => '1.0.5'

Add the following line to your Podfile to install using CocoaPods.

pod 'Chargebee'

Follow the step to install SDK using Swift Package Manager.

• Select File > Swift Packages > Add Package Dependency

• Add repository URL https://github.com/chargebee/chargebee-ios

This is an optional step that helps you to verify the SDK implementation using this example project. You can download or clone the example project via GitHub.

To run the example project, follow these steps.

• Clone the repo - https://github.com/chargebee/chargebee-ios.

• Run pod install from the Example directory.

There are two types of configuration.

• Configuration for In-App Purchases

• Configuration for credit card using tokenization

To configure the Chargebee iOS SDK for completing and managing In-App Purchases, follow these steps.

• Integrate the App Store Connect with your Chargebee site.

• On the Sync Overview page of the web app, click View Keys and use the value of generated App ID as the SDK Key.

• 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 step. Read more.

• Initialize the SDK with your Chargebee site, Publishable API Key, and SDK Key by including the following snippets in your app delegate during app startup.

import Chargebee

Chargebee.configure(site: "your-site",
                    apiKey: "publishable_api_key",
                    sdkKey: "ResourceID/SDK Key")
}

To configure SDK only for tokenizing credit card details, follow these steps.

• Initialize the SDK with your Chargebee Site and Publishable/Full Access Key.

• Initialize the SDK during your app startup by including the following snippets in your app delegate.

import Chargebee

Chargebee.configure(site: "your-site", apiKey: "publishable_api_key")

This section describes the SDK integration processes.

• Integrating In-App Purchases

• Integrating credit card tokenization

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

Every In-App Purchase subscription product you configure in your App Store Connect account can be configured in Chargebee as a Plan. Start by retrieving the Apple IAP Product IDs from your Chargebee account.

CBPurchase.shared.retrieveProductIdentifers(queryParams :["String": "String"], completion:  { result in
switch result {
    case let .success(products):
        print("array of Products Id's \(products)")
    case let .failure(error):
        // Handle error here
}
})

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

The above function will automatically determine your product catalog version in Chargebee and call the relevant APIs to retrieve the Chargebee Plans that correspond to Apple IAP products and their Apple IAP Product IDs.

You can then convert the IAP Product IDs to Apple IAP Product objects with the following function.

CBPurchase.shared.retrieveProducts(withProductID : ["Product ID from Apple"],completion: { result in
    switch result {
    case let .success(products):
        print("array of Products \(products)")
    case let .failure(error):
        // Handle error here
}
}

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

Pass the product and customer identifiers to the following function when the user chooses the product to purchase.

customerId - Optional parameter. We need the unique ID of your customer as customerId. If your unique list of customers is maintained in your database or a third-party system, send us the unique ID from that source.

CBPurchase.shared.purchaseProduct(product: "CBProduct",customerId: "CustomerID") { result in
    switch result {
        case .success(let result):
            print(result.status)
            print(result.subscriptionId) // this will print the subscription ID object
        case .failure(let error):
            // Handle error here
    }
}

The above function will handle the purchase against App Store Connect and send the IAP 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.

The following are methods for checking the subscription status of a subscriber who 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.

Chargebee.shared.retrieveSubscriptions(queryParams :["String" : "String"]") { result in
    switch result {
    case let .success(resultarray):
        print("Status \(resultarray.first.subscription.status)")
    case let .error(error):
        // Handle error here
    }
}

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

Use only Subscription ID for checking the Subscription status on Chargebee and confirm the access - granted or denied.

Chargebee.shared.retrieveSubscription(forID: "SubscriptionID") { result in
    switch result {
    case let .success(result):
        print("Status \(result.status)")
    case let .error(error):
        // Handle error here
    }
}

The following section describes how to use the SDK to tokenize credit card information.

If your Chargebee site is configured to PC 2.0, use the following functions to retrieve the product or product list for purchase.

Retrieve the list of items using the following function.

  CBItem.retrieveAllItems(queryParams :["String" : "String"], completion:  { result in
                DispatchQueue.main.async {
                    switch result {
                    case let .success(itemLst):
                        self.items =  itemLst.list
                        debugPrint("items: \(self.items)")
                        self.performSegue(withIdentifier: "itemList", sender: self)
                    case let .error(error):
                        debugPrint("Error: \(error.localizedDescription)")
                    }
                }
    })

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

Retrieve specific item details using the following function. Use the Item ID that you received from the previous function - Get all items.

CBItem.retrieveItem("Item ID"){ (itemResult) in
            switch itemResult {
            case .success(let item):
                print(item)
                self.itemName.text = item.name
                self.itemStatus.text = item.status

            case .error(let error):
                print("Error\(error)")
                self.error.text = error.localizedDescription
            }
        }

If your Chargebee site is configured to PC 1.0, use the relevant functions to retrieve the product or product list for purchase.

Retrieve a list of plans using the following function.

CBPlan.retrieveAllPlans(queryParams: ["String":"String" ]) { (result) in
    switch result {
    case .success(let plan):
        print("Plan Array: \(plan)")
        // Use plan details here
    case .error(let error):
        // Handle error here
    }
}

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

Retrieve specific plan details passing plan ID in the following function.

CBPlan.retrieve("planId") { (planResult) in
    switch planResult {
    case .success(let plan):
        print("Plan Name: \(plan.name)")
        // Use plan details here
    case .error(let error):
        // Handle error here
    }
}

Retrieve specific addon details passing addon ID in the following function.

CBAddon.retrieve("addonId") { (addonResult) in
    switch addonResult {
    case .success(let addon):
        print("Addon Name: \(addon.name)")
        // Use addon details here
    case .error(let error):
        // Handle error here
    }
}

Once the user selects the product to purchase, and you collect the credit card information, use the following function to tokenize the credit card details against Stripe. You need to have connected your Stripe account to your Chargebee site.

let card = CBCard(
        cardNumber: "4321567890123456",
        expiryMonth: "12",
        expiryYear: "29",
        cvc: "123")

let paymentDetail = CBPaymentDetail(type: CBPaymentType.Card, currencyCode: "USD", card: card)

CBToken.createTempToken(paymentDetail: paymentDetail) { tokenResult in
    switch tokenResult {
    case .success(let token):
        print("Chargebee Token \(token)")
        // Use token here
    case .error(let error):
        // Handle error here
    }
}

After the customer's card data is processed and stored and a Chargebee token reference is returned to you, use the token in subsequent API calls to process transactions.

The following are some endpoints that accept Chargebee tokens for processing subscriptions.

• Create a Payment Source for the customer

• Create a Subscription

• Update a Subscription

Please refer to the Chargebee API Docs for subsequent integration steps.

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