RevenueCat
This is a free Skip Swift/Kotlin framework that provides integration with the RevenueCat ↗ SDK for in-app purchases and subscriptions on iOS ↗ and Android ↗.
The framework contains two modules:
- SkipRevenue — Core service for configuring RevenueCat, loading offerings, purchasing packages, restoring purchases, and managing customer info.
- SkipRevenueUI — A
RCFusePaywallViewSwiftUI component that presents RevenueCat’s native paywall UI on both platforms.
To include this framework in your project, add the following
dependency to your Package.swift file:
let package = Package( name: "my-package", products: [ .library(name: "MyProduct", targets: ["MyTarget"]), ], dependencies: [ .package(url: "https://source.skip.dev/skip-revenue.git", "0.0.0"..<"2.0.0"), ], targets: [ .target(name: "MyTarget", dependencies: [ .product(name: "SkipRevenue", package: "skip-revenue"), .product(name: "SkipRevenueUI", package: "skip-revenue") ]) ])If you only need the core purchase APIs without the paywall UI, you can depend on SkipRevenue alone.
RevenueCat Account Setup
Section titled “RevenueCat Account Setup”Before using this framework you must create a RevenueCat ↗ account and configure your project with API keys for both platforms. See the RevenueCat Getting Started ↗ guide and Configuring Products ↗ documentation for details on setting up your products, offerings, and entitlements in the RevenueCat dashboard.
Configuration
Section titled “Configuration”Configure the RevenueCat SDK early in your app’s lifecycle, typically in your App init or onAppear:
import SkipRevenue
@main struct MyApp: App { init() { #if !SKIP RevenueCatFuse.shared.configure(apiKey: "appl_your_ios_api_key") #else RevenueCatFuse.shared.configure(apiKey: "goog_your_android_api_key") #endif }
var body: some Scene { WindowGroup { ContentView() } }}See the RevenueCat API Keys ↗ documentation for information on obtaining your platform-specific API keys.
User Identification
Section titled “User Identification”Identify users with their own user IDs, or let RevenueCat generate anonymous IDs:
// Log in with a known user IDtry await RevenueCatFuse.shared.loginUser(userId: "user-123")
// Log out when the user signs outtry await RevenueCatFuse.shared.logoutUser()See Identifying Users ↗ for more on user identification strategies.
Loading Offerings and Products
Section titled “Loading Offerings and Products”Offerings represent the products you’ve configured in the RevenueCat dashboard:
import SwiftUIimport SkipRevenue
struct StoreView: View { @State var packages: [RCFusePackage] = [] @State var errorMessage: String?
var body: some View { List(packages, id: \.identifier) { package in HStack { Text(package.identifier) Spacer() Text(package.storeProduct.localizedPriceString) } } .task { do { packages = try await RevenueCatFuse.shared.loadProducts() } catch { errorMessage = error.localizedDescription } } }}You can also load the full offerings tree to access specific offerings by identifier:
let offerings = try await RevenueCatFuse.shared.loadOfferings()
// Access the default offeringif let current = offerings.current { let packages = current.availablePackages}
// Access a specific offeringif let premium = offerings.offering(identifier: "premium") { let packages = premium.availablePackages}See Displaying Products ↗ for more on configuring and presenting offerings.
Purchasing
Section titled “Purchasing”The purchase API differs slightly between platforms because Android requires an Activity reference:
// iOS#if !SKIPlet customerInfo = try await RevenueCatFuse.shared.purchase(package: package)#else// Android — pass the current activitylet customerInfo = try await RevenueCatFuse.shared.purchase( package: package, activity: ProcessInfo.processInfo.androidContext)#endifHandle purchase errors, including user cancellation:
do { #if !SKIP let customerInfo = try await RevenueCatFuse.shared.purchase(package: package) #else let customerInfo = try await RevenueCatFuse.shared.purchase( package: package, activity: ProcessInfo.processInfo.androidContext ) #endif // Purchase succeeded — check entitlements let active = customerInfo.activeEntitlements} catch let error as StoreError where error == .userCancelled { // User cancelled — no action needed} catch { // Handle other errors}See Making Purchases ↗ for more details.
Restoring Purchases
Section titled “Restoring Purchases”Allow users to restore purchases on a new device or after reinstalling:
let customerInfo = try await RevenueCatFuse.shared.restorePurchases()let activeEntitlements = customerInfo.activeEntitlementsSee Restoring Purchases ↗ for platform-specific considerations.
Checking Customer Info
Section titled “Checking Customer Info”Query the current customer’s entitlement status at any time:
let customerInfo = try await RevenueCatFuse.shared.getCustomerInfo()
if customerInfo.activeEntitlements.contains("pro") { // User has the "pro" entitlement}
let purchasedProducts = customerInfo.allPurchasedProductIdentifiersSee Customer Info ↗ for more on working with customer data and Entitlements ↗ for configuring access levels.
Paywall UI
Section titled “Paywall UI”The SkipRevenueUI module provides RCFusePaywallView, which presents RevenueCat’s native paywall UI. On iOS this uses PaywallView from RevenueCatUI, and on Android it uses the RevenueCat Compose Paywall component.
import SwiftUIimport SkipRevenueimport SkipRevenueUI
struct SubscriptionView: View { @State var showPaywall = false
var body: some View { Button("Subscribe") { showPaywall = true } .sheet(isPresented: $showPaywall) { RCFusePaywallView( onPurchaseCompleted: { userId in // Purchase succeeded — userId is the customer's user ID showPaywall = false }, onRestoreCompleted: { userId in // Restore succeeded showPaywall = false }, onDismiss: { showPaywall = false } ) } }}To display a specific offering in the paywall, pass an RCFuseOffering:
let offerings = try await RevenueCatFuse.shared.loadOfferings()if let premium = offerings.offering(identifier: "premium") { RCFusePaywallView( offering: premium, onPurchaseCompleted: { userId in }, onDismiss: { } )}See the RevenueCat Paywalls ↗ documentation for information on designing and configuring paywall templates in the RevenueCat dashboard.
Building
Section titled “Building”This project is a free Swift Package Manager module that uses the Skip plugin to transpile Swift into Kotlin.
Building the module requires that Skip be installed using
Homebrew ↗ with brew install skiptools/skip/skip.
This will also install the necessary build prerequisites:
Kotlin, Gradle, and the Android build tools.
Testing
Section titled “Testing”The module can be tested using the standard swift test command
or by running the test target for the macOS destination in Xcode,
which will run the Swift tests as well as the transpiled
Kotlin JUnit tests in the Robolectric Android simulation environment.
Parity testing can be performed with skip test,
which will output a table of the test results for both platforms.
Contributing
Section titled “Contributing”We welcome contributions to SkipRevenue. The Skip product documentation includes helpful instructions and tips on local Skip library development.