Getting Started with RevenueCat Bridge

Install the plugin, set up RevenueCat, configure your API keys, and make your first purchase.

Prerequisites

1. A RevenueCat account - sign up free at revenuecat.com
2. A Google Play Console account (for Android) and/or App Store Connect (for iOS)
3. Products created in your store console (subscriptions, one-time purchases, etc.)
4. Products linked in the RevenueCat dashboard with at least one Offering and one Entitlement

Step 1: Install the Plugin

From Fab Marketplace

1. Purchase RevenueCat Bridge on Fab Marketplace
2. In the Epic Games Launcher or Fab, click Add to Project
3. Select your Unreal Engine project
4. Restart the editor if prompted

Manual Installation

1. Copy the RevenueCatBridge folder into your project's Plugins/ directory
2. Your folder structure should look like:

   YourProject/
     Plugins/
       RevenueCatBridge/
         RevenueCatBridge.uplugin
         Source/
   

3. Open your project in Unreal Editor
4. Go to Edit > Plugins, search for "RevenueCat Bridge", and make sure it's enabled
5. Restart the editor

Verify Installation

Step 2: Get Your API Keys

1. Log into the RevenueCat dashboard
2. Select your project (or create one)
3. Go to API Keys in the left sidebar
4. Copy the Public API key for each platform:
   • Android: the key labeled "Google Play" or "Android"
   • iOS: the key labeled "App Store" or "iOS"

These are public API keys. They are safe to include in your app binary. RevenueCat designed them that way - they can only be used to read offerings and make purchases, not to modify your account.

Step 3: Configure the Plugin

1. In Unreal Editor, go to Project Settings > Plugins > RevenueCat
2. Fill in:

3. Save

Step 4: Set Up Your Store (if you haven't already)

Android (Google Play)

1. Create your app in Google Play Console
2. Go to Monetize > Products > Subscriptions (or In-app products)
3. Create your products (monthly sub, annual sub, lifetime unlock, etc.)
4. Set up an Internal Testing track and add yourself as a tester
5. Upload a signed build to the internal testing track (you need this even for local testing of purchases)

iOS (App Store)

1. Create your app in App Store Connect
2. Go to the app > In-App Purchases or Subscriptions
3. Create your products
4. Create a Sandbox tester in Users & Access > Sandbox

RevenueCat Dashboard

1. In your RevenueCat project, go to Products
2. Add your store product IDs and link them to the right store
3. Go to Entitlements and create your entitlements (e.g. "pro")
4. Link products to entitlements
5. Go to Offerings and create an offering with packages (e.g. a Monthly package using your monthly subscription product)
6. Mark one offering as Current

Step 5: Your First Purchase Flow (Blueprint)

5a: Fetch Offerings on Game Start

1. Search for Fetch Offerings (Async) in the action palette
2. Drag it into your Event Graph
3. Connect Event BeginPlay to the node's input
4. From the On Success pin, you get a TArray<FRevenueCatOffering> - these are your products

5b: Display Products

1. Use a For Each Loop to iterate through offerings
2. Find the one where bIsCurrent is true (this is the offering you marked as Current in the dashboard)
3. Loop through its Packages array
4. Each package has a Product with Title, PriceString (e.g. "$4.99"), and Description
5. Display these in your UI however you want (UMG widgets, text, etc.)

5c: Purchase a Package

1. Search for Purchase Package (Async) in the action palette
2. Pass in the FRevenueCatPackage the player selected
3. On Success - purchase went through. Check entitlements.
4. On Cancelled - player dismissed the dialog. Do nothing.
5. On Failure - something went wrong. Show an error message.

5d: Check Entitlements

1. Get the RevenueCat Subsystem (search "Get RevenueCatSubsystem")
2. Call Is Entitlement Active with your entitlement ID (e.g. "pro")
3. If true, unlock premium content. If false, show the paywall.

5e: Restore Purchases

1. Search for Restore Purchases (Async)
2. On On Success, re-check entitlements and update your UI

Step 5 (Alternative): C++ Setup

// Get the subsystem from anywhere
URevenueCatSubsystem* RC = GetGameInstance()->GetSubsystem<URevenueCatSubsystem>();
 
// Bind to events
RC->OnOfferingsFetched.AddDynamic(this, &UMyClass::HandleOfferings);
RC->OnPurchaseCompleted.AddDynamic(this, &UMyClass::HandlePurchase);
RC->OnError.AddDynamic(this, &UMyClass::HandleError);
 
// Fetch offerings
RC->FetchOfferings();

void UMyClass::HandleOfferings(const TArray<FRevenueCatOffering>& Offerings)
{
    for (const FRevenueCatOffering& Offering : Offerings)
    {
        if (Offering.bIsCurrent)
        {
            for (const FRevenueCatPackage& Package : Offering.Packages)
            {
                UE_LOG(LogTemp, Log, TEXT("Product: %s - %s"),
                    *Package.Product.Title,
                    *Package.Product.PriceString);
            }
        }
    }
}

// When the player wants to buy something
RC->PurchasePackage(SelectedPackage);

void UMyClass::HandlePurchase(ERevenueCatPurchaseResult Result,
    const FRevenueCatCustomerInfo& CustomerInfo)
{
    if (Result == ERevenueCatPurchaseResult::Success)
    {
        if (RC->IsEntitlementActive("pro"))
        {
            // Unlock premium content
        }
    }
}

Step 6: Test on a Real Device

Android

1. Build and deploy to your device. The app must be signed with the same key as your Play Console upload.
2. Your Google account must be listed as a license tester in Play Console > Settings > License testing.
3. The app must be published to at least the Internal Testing track.
4. On device, make sure you're signed into the Google account that's a license tester.

iOS

1. Build and run on a real device via Xcode or your build pipeline.
2. On device, go to Settings > App Store > Sandbox Account and sign in with your sandbox tester credentials.
3. Alternatively, the sandbox login prompt will appear when you try to make a purchase.

What to look for

• [RevenueCat] SDK configured successfully. in the log on startup
• FetchOfferings returns your products with correct prices
• Tapping "Buy" opens the native store dialog
• After purchase, IsEntitlementActive returns true

Common Pitfalls

• Products not linked to an offering in the RevenueCat dashboard
• Store products not approved / not active yet
• Wrong API key (check you're using the right platform key)

• App not published to internal testing track (Android)
• Not signed in as a license tester (Android)
• Sandbox account not configured (iOS)
• Building a debug/development configuration that isn't signed correctly

• Entitlement not linked to the product in RevenueCat dashboard
• Typo in the entitlement ID string
• Not waiting for OnPurchaseCompleted before checking (the data is async)

• Check the platform-specific logs (Logcat for Android, Xcode Console for iOS)
• Make sure both API keys are set in Project Settings

Next Steps

• API Reference - every function, delegate, struct, and enum
• Testing & Troubleshooting - the full 14-phase test plan, edge cases, and logging tips