Test Mode
Simulate in-app purchases without Google Play using test mode, which lets you test your entire paywall flow end-to-end.
Test mode lets you simulate in-app purchases without involving Google Play Billing or any external purchase controller. When active, all purchases are faked and product data is retrieved from the Superwall dashboard. This makes it easy to test your entire paywall flow end-to-end, including purchase, restore, and entitlement changes, without needing a Google Play sandbox account or test tracks.
How it works
When test mode is active:
- Product data comes from the dashboard instead of Google Play, so you don't need products set up in Google Play Console.
- Purchases are simulated. Instead of the Google Play purchase flow, a test mode drawer appears letting you choose to complete, abandon, or fail the transaction. Purchase events fire normally, so your analytics and delegate callbacks work as expected.
- Restores are simulated. A restore drawer lets you pick which entitlements to restore and in what state.
- A configuration modal appears on launch showing why test mode activated, your User ID, purchase controller status, device and user attributes, free trial override, and starting entitlements. You can use this to configure the test session before interacting with your paywalls.
Activating test mode
There are two ways to activate test mode:
1. From the dashboard
Mark specific users as test store users in the Superwall dashboard. When the SDK detects that the current user's ID matches a test store user from your config, test mode activates automatically. This is the most common approach.
2. From the SDK
Set testModeBehavior on SuperwallOptions before calling configure:
val options = SuperwallOptions().apply {
testModeBehavior = TestModeBehavior.ALWAYS
}
Superwall.configure(this, "your-api-key", options = options)The available behaviors are:
| Behavior | Description |
|---|---|
AUTOMATIC | (Default) Activates when the current user is marked as a test store user in the dashboard, or when the app's application ID doesn't match the one configured in the dashboard. Never activates when JUnit or Espresso is detected on the classpath. |
WHEN_ENABLED_FOR_USER | Activates only when the current user is marked as a test store user in the dashboard. Ignores application ID mismatches. |
ALWAYS | Always activates test mode, regardless of dashboard configuration. Useful during local development. |
NEVER | Never activates test mode, regardless of configuration. |
The configuration modal
When test mode activates, a modal appears before you interact with any paywalls. It displays:
- Reason: Why test mode activated (e.g., application ID mismatch, matched test store user, or always-on via options).
- User ID: Your current user ID, with a link to view the user in the dashboard.
- Purchase Controller: Whether you've provided a custom purchase controller.
- Device Attributes: Tap to view all device-level attributes the SDK is tracking.
- User Attributes: Tap to view all user-level attributes.
- Free Trial Override: Override free trial availability for all products. Choose Use Default (respects the product's actual trial status), Force Available, or Force Unavailable.
- Starting Entitlements: If you have entitlements configured, you can set each one's state before dismissing the modal. Available states include Subscribed, In Grace Period, Billing Retry, Expired, Revoked, and Inactive. For active states you can also set the offer type (None, Trial, or Promotional). This lets you test how your paywalls behave for users with different entitlement states.
Tap Continue to dismiss the modal and begin testing. Your selections persist across sessions.
Simulating purchases
When you tap a purchase button on a paywall while test mode is active, a drawer appears instead of the Google Play purchase flow.
The drawer shows the product details (identifier, price, period, free trial availability, and entitlements) along with these options:
- Confirm Purchase (or Start Free Trial if the product has a free trial): Simulates a successful purchase. The product's entitlements are activated and your subscription status updates accordingly.
- Abandon: Closes the drawer without completing the purchase.
- Fail: Simulates a purchase failure.
Standard Superwall events (transaction_start, transaction_complete, transaction_abandon, transaction_fail, etc.) fire as they normally would, so you can verify your analytics and delegate callbacks.
Simulating restores
When a restore is triggered while test mode is active, a drawer appears letting you select which entitlements to restore and in what state. This is useful for testing how your app handles different restore scenarios.
When to use test mode vs. Google Play testing
| Test mode | Google Play testing | |
|---|---|---|
| Setup | No Google Play Console setup needed | Requires products in Google Play Console and license testers configured |
| Products | Pulled from the Superwall dashboard | Must exist in Google Play Console |
| Transactions | Simulated via UI drawer | Real Google Play Billing transactions in a test environment |
| Best for | End-to-end paywall flow testing, verifying entitlement gating, testing without Google Play Console setup | Testing real billing behavior, receipt validation, subscription lifecycle |
Test mode is ideal for quickly validating your paywall presentation, purchase flows, and entitlement gating without any Google Play setup. For testing actual Google Play Billing behavior, use Google Play's license testing and test tracks instead.
How is this guide?