Advanced Purchasing

By default, Superwall handles basic subscription-related logic for you:

1. Purchasing: When the user initiates a checkout on a paywall.
2. Restoring: When the user restores previously purchased products.
3. Subscription Status: When the user's subscription status changes to active or expired (by checking the local receipt).

However, if you want more control, you can pass in a PurchaseController when configuring the SDK via configure(apiKey:purchaseController:options:) and manually set Superwall.shared.subscriptionStatus to take over this responsibility.

Step 1: Creating a PurchaseController

A PurchaseController handles purchasing and restoring via protocol methods that you implement.

// MyPurchaseController.kt

class MyPurchaseController(val context: Context): PurchaseController {

  // 1
  override suspend fun purchase(
    activity: Activity,
    productDetails: ProductDetails,
    basePlanId: String?,
    offerId: String?
  ): PurchaseResult {

    // TODO
    // ----
    // Purchase via GoogleBilling, RevenueCat, Qonversion or however
    // you like and return a valid PurchaseResult

    return PurchaseResult.Purchased()
  }

  // 2
  override suspend fun restorePurchases(): RestorationResult {

    // TODO
    // ----
    // Restore purchases and return true if successful.

    return RestorationResult.Success()
  }
}

Here’s what each method is responsible for:

1. Purchasing a given product. In here, enter your code that you use to purchase a product. Then, return the result of the purchase as a PurchaseResult. For Flutter, this is separated into purchasing from the App Store and Google Play. This is an enum that contains the following cases, all of which must be handled:
   1. .cancelled: The purchase was cancelled.
   2. .purchased: The product was purchased.
   3. .pending: The purchase is pending/deferred and requires action from the developer.
   4. .failed(Error): The purchase failed for a reason other than the user cancelling or the payment pending.
2. Restoring purchases. Here, you restore purchases and return a RestorationResult indicating whether the restoration was successful or not. If it was, return .restore, or failed along with the error reason.

Step 2: Configuring the SDK With Your PurchaseController

Pass your purchase controller to the configure(apiKey:purchaseController:options:) method:

// MainApplication.kt

class MainApplication : android.app.Application(), SuperwallDelegate {

    override fun onCreate() {
        super.onCreate()

        Superwall.configure(this, "MY_API_KEY", MyPurchaseController(this))
        // OR using the DSL
        configureSuperwall("MY_API_KEY") {
           purchaseController = MyPurchaseController(this@MainApplication)
        }
    }
}

Step 3: Keeping subscriptionStatus Up-To-Date

You must set Superwall.shared.subscriptionStatus every time the user's subscription status changes, otherwise the SDK won't know who to show a paywall to. This is an enum that has three possible cases:

1. .unknown: This is the default value. In this state, paywalls will not show and their presentation will be automatically delayed until subscriptionStatus changes to a different value.
2. .active(let entitlements): Indicates that the user has an active entitlement. Paywalls will not show in this state unless you remotely set the paywall to ignore subscription status. A user can have one or more active entitlement.
3. .inactive: Indicates that the user doesn't have an active entitlement. Paywalls can show in this state.

Here's how you might do this:

// When a subscription is purchased, restored, validated, expired, etc...
myService.subscriptionStatusDidChange {
  if (it.hasActiveSubscription) {
    Superwall.instance.setSubscriptionStatus(SubscriptionStatus.Active(entitlements))
  } else {
    Superwall.instance.setSubscriptionStatus(SubscriptionStatus.Inactive(entitlements))
  }
}

Listening for subscription status changes

If you need a simple way to observe when a user's subscription status changes, on iOS you can use the Publisher for it. Here's an example:

Superwall.instance.subscriptionStatus.collect { status: SubscriptionStatus ->
 // React to changes
}

You can do similar tasks with the SuperwallDelegate, such as viewing which product was purchased from a paywall.

Product Overrides

When using a PurchaseController, you may want to override specific products shown on your paywalls. This is useful for:

• A/B testing different subscription tiers
• Showing region-specific products
• Dynamically changing products based on user segments
• Testing promotional pricing without modifying paywalls

How Product Overrides Work:

1. Product names (e.g., "primary", "secondary") must match exactly as defined in the Superwall dashboard's Paywall Editor
2. The SDK substitutes the original product IDs with your override IDs before fetching from the App Store
3. The paywall maintains its visual design while showing the substituted products
4. Your PurchaseController will receive the overridden products when purchase(product:) is called