# SuperwallOptions

A configuration class for customizing paywall appearance and behavior.

> **Warning**

Only modify `networkEnvironment` if explicitly instructed by the Superwall team. Use `.RELEASE` (default) for production apps.



> **Tip**

Use different `SuperwallOptions` configurations for debug and release builds to optimize logging, purchasing behavior, and Google Play settings for each environment.



Purpose [#purpose]

Configures paywall presentation, logging, Google Play purchase behavior, and other global SDK settings. Pass an instance in to [`Superwall.configure`](/docs/android/sdk-reference/configure).

Signature [#signature]

```kotlin
class SuperwallOptions {
    var paywalls: PaywallOptions = PaywallOptions()
    var shouldObservePurchases: Boolean = false
    var networkEnvironment: NetworkEnvironment = NetworkEnvironment.Release()
    var isExternalDataCollectionEnabled: Boolean = true
    var localeIdentifier: String? = null
    var isGameControllerEnabled: Boolean = false
    var passIdentifiersToPlayStore: Boolean = false
    var enableExperimentalDeviceVariables: Boolean = false
    var logging: Logging = Logging()
    var useMockReviews: Boolean = false
    var testModeBehavior: TestModeBehavior = TestModeBehavior.AUTOMATIC
}
```

```java
// Java
public class SuperwallOptions {
    public PaywallOptions paywalls = new PaywallOptions();
    public boolean shouldObservePurchases = false;
    public NetworkEnvironment networkEnvironment = new NetworkEnvironment.Release();
    public boolean isExternalDataCollectionEnabled = true;
    public @Nullable String localeIdentifier = null;
    public boolean isGameControllerEnabled = false;
    public boolean passIdentifiersToPlayStore = false;
    public boolean enableExperimentalDeviceVariables = false;
    public Logging logging = new Logging();
    public boolean useMockReviews = false;
    public TestModeBehavior testModeBehavior = TestModeBehavior.AUTOMATIC;
}
```

Parameters [#parameters]

<TypeTable
  type="{
  paywalls: {
    type: &#x22;PaywallOptions&#x22;,
    typeDescriptionLink: &#x22;/android/sdk-reference/PaywallOptions&#x22;,
    description: &#x22;Controls paywall presentation, preload, and alert behavior.&#x22;,
    required: true,
  },
  shouldObservePurchases: {
    type: &#x22;Boolean&#x22;,
    description: &#x22;Set to `true` to have Superwall observe Google Play purchases you make outside the SDK.&#x22;,
    required: true,
  },
  networkEnvironment: {
    type: &#x22;NetworkEnvironment&#x22;,
    description: &#x22;Overrides the API environment. **Only change if instructed by Superwall.**&#x22;,
    required: true,
  },
  isExternalDataCollectionEnabled: {
    type: &#x22;Boolean&#x22;,
    description: &#x22;Allows Superwall to send non-paywall analytics events to the backend.&#x22;,
    default: &#x22;true&#x22;,
  },
  localeIdentifier: {
    type: &#x22;String?&#x22;,
    description: &#x22;Overrides the locale used for rule evaluation (e.g., `\&#x22;en_GB\&#x22;`).&#x22;,
  },
  isGameControllerEnabled: {
    type: &#x22;Boolean&#x22;,
    description: &#x22;Forwards game controller events to paywalls.&#x22;,
    required: true,
  },
  passIdentifiersToPlayStore: {
    type: &#x22;Boolean&#x22;,
    description: &#x22;When `true`, Google Play receives the raw `userId` as `obfuscatedExternalAccountId`; otherwise Superwall sends a SHA-256 hash.&#x22;,
    required: true,
  },
  enableExperimentalDeviceVariables: {
    type: &#x22;Boolean&#x22;,
    description: &#x22;Enables experimental device variables (subject to change).&#x22;,
    required: true,
  },
  logging: {
    type: &#x22;Logging&#x22;,
    description: &#x22;Sets log level and scopes printed to Logcat.&#x22;,
    required: true,
  },
  useMockReviews: {
    type: &#x22;Boolean&#x22;,
    description: &#x22;Shows mock Google Play review dialogs for testing.&#x22;,
    required: true,
  },
  testModeBehavior: {
    type: &#x22;TestModeBehavior&#x22;,
    description: &#x22;Controls when test mode activates. `AUTOMATIC` enables test mode when an application ID mismatch is detected. `WHEN_ENABLED_FOR_USER` only activates when the user is marked as a test store user in the dashboard. `ALWAYS` forces test mode on. `NEVER` disables it entirely.&#x22;,
    default: &#x22;AUTOMATIC&#x22;,
  },
}"
/>

How `passIdentifiersToPlayStore` affects Google Play [#how-passidentifierstoplaystore-affects-google-play]

Superwall always calls `BillingFlowParams.Builder.setObfuscatedAccountId(Superwall.instance.externalAccountId)` when launching a billing flow.

* **Default (`false`)** – `externalAccountId` is a SHA-256 hash of the `userId`. Google Play displays the hashed value as `obfuscatedExternalAccountId`, and the same hash is sent back to your servers.
* **Enabled (`true`)** – Superwall forwards the exact `appUserId` you passed to [`identify()`](/docs/android/sdk-reference/identify). This makes it easier to correlate Google Play purchases with your users, but the value must comply with [Google's policy](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedAccountId) and must not contain PII.

Configure it as part of your application startup:

```kotlin
val options = SuperwallOptions().apply {
    passIdentifiersToPlayStore = true
    logging.level = LogLevel.info
}

Superwall.configure(
    application = this,
    apiKey = "pk_your_api_key",
    options = options
)
```

Related [#related]

* [`PaywallOptions`](/docs/android/sdk-reference/PaywallOptions)