Welcome
Welcome to the Superwall Unity SDK beta documentation.
The Unity SDK is in beta. APIs, platform requirements, and package behavior may change before a stable release.
The Superwall Unity SDK lets Unity mobile games present Superwall paywalls on iOS and Android. It is a Unity package with a C# API that bridges to the native Superwall iOS SDK and Superwall Android SDK.
Quick Links
Install the SDK
Add the beta package through Unity Package Manager.
Configure Superwall
Configure the SDK once when your game starts.
Present Paywalls
Register placements from C# and unlock game features.
Game Controller Input
Enable controller-aware paywall actions for mobile games.
SDK Reference
Review the beta C# API surface.
GitHub Repository
View the Unity package source.
How It Works
The package exposes a Superwall C# namespace for Unity scripts. At runtime:
- Your game calls
Superwall.Configure(...)once with a Superwall Public API Key. - The Unity package creates a persistent
SuperwallBridgeGameObject for callbacks. - C# calls are forwarded to native iOS or Android bridge code.
- The native Superwall SDK fetches campaigns, evaluates placements on device, presents the paywall, and returns callbacks to Unity.
- Your C#
featurecallback runs when the user has access.
On iOS, the package's post-build processor adds SuperwallKit to the generated Xcode project through CocoaPods. On Android, the package includes a Gradle .androidlib module that pulls the Superwall Android SDK and Google Play Billing dependencies.
Requirements
- Unity 6+ (
6000.4+) - iOS 16.0+
- Android
minSdkVersion25+ - CocoaPods for iOS builds
- A Superwall project with mobile app credentials and at least one placement
The Unity Editor uses stubbed native calls and logs method names. Test paywall presentation, purchases, and native callbacks on an iOS or Android build.
How is this guide?