Redeeming In-App

After purchasing from a web paywall, the user will be presented with a link to install your app and another to redeem their purchase on device. This redeem link is a deep link that redirects to your app. Please follow our deep link setup guide to ensure everything is correctly configured.

When your app opens via the deep link, we will call the delegate method willRedeemCode() before making a network call to redeem the code. At this point, you might wish to display a loading indicator in your app in case of network issues. After receiving a response from the network, we will call didRedeemCode(result:) with the result of redeeming the code. This is an enum that has the following cases:

• success(code: String, redemptionInfo: RedemptionInfo): The redemption succeeded and redemptionInfo contains information about the redeemed code.
• error(code: String, error: ErrorInfo): An error occurred while redeeming. You can check the error message via the error parameter.
• codeExpired(code: String, expired: ExpiredInfo): The code expired and ExpiredInfo contains information about whether a redemption email has been resent and an optional obfuscated email address that the redemption email was sent to.
• invalidCode(code: String): The code that was redeemed was invalid.
• expiredSubscription(code: String, redemptionInfo: RedemptionInfo): The subscription that the code redeemed has expired.

On network failure, the SDK will retry up to 6 times before returning an error RedemptionResult in didRedeemCode(result:).

Superwall will automatically update the subscription status with the redeemed web entitlements. However, if you’re using a PurchaseController, you will need to handle this yourself.

​

Using a PurchaseController

If you’re using StoreKit in your PurchaseController, you’ll need to merge the web entitlements with the device entitlements before setting the subscription status. Here’s an example of how you might do this:

func syncSubscriptionStatus() async {
  var products: Set<String> = []

  // Get the device entitlements
  for await verificationResult in Transaction.currentEntitlements {
    switch verificationResult {
    case .verified(let transaction):
      products.insert(transaction.productID)
    case .unverified:
      break
    }
  }
  let storeProducts = await Superwall.shared.products(for: products)
  let deviceEntitlements = Set(storeProducts.flatMap { $0.entitlements })

  // Get the web entitlements from Superwall
  let webEntitlements = Superwall.shared.entitlements.web

  // Merge the two sets of entitlements
  let allEntitlements = deviceEntitlements.union(webEntitlements)

  await MainActor.run {
    Superwall.shared.subscriptionStatus = .active(allEntitlements)
  }
}

In addition to syncing the subscription status when purchasing and restoring, you’ll need to sync it whenever didRedeemCode(result:) is called:

final class Delegate: SuperwallDelegate {
  func didRedeemCode(result: RedemptionResult) {
    Task {
      await syncSubscriptionStatus()
    }
  }
}

​

Using a PurchaseController with RevenueCat

If you’re using RevenueCat, you’ll need to follow steps 1 to 4 in their guide to set up Stripe with RevenueCat. Then, you’ll need to associate the RevenueCat customer with the Stripe subscription IDs returned from redeeming the code. You can do this by extracting the ids from the RedemptionResult and sending them to RevenueCat’s API by using the didRedeemCode(result:) delegate method:

import Foundation
import RevenueCat

final class Delegate: SuperwallDelegate {
  func didRedeemCode(result: RedemptionResult) {
    guard let stripeSubscriptionIds = result.stripeSubscriptionIds else {
      return
    }

    let revenueCatStripePublicAPIKey = "strp_pfIhWPVBApdRldicuzPVpJUNTgA"
    let appUserId = Purchases.shared.appUserID

    guard let url = URL(string: "https://api.revenuecat.com/v1/receipts") else {
      return
    }

    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.addValue("application/json", forHTTPHeaderField: "Content-Type")
    request.addValue("application/json", forHTTPHeaderField: "accept")
    request.addValue("stripe", forHTTPHeaderField: "X-Platform")
    request.addValue("Bearer \(revenueCatStripePublicAPIKey)", forHTTPHeaderField: "Authorization")

    for stripeSubscriptionId in stripeSubscriptionIds {
      let requestBody: [String: String] = [
        "app_user_id": appUserId,
        "fetch_token": stripeSubscriptionId
      ]

      request.httpBody = try? JSONEncoder().encode(requestBody)

      let task = URLSession.shared.dataTask(with: request)
      task.resume()
    }
  }
}

The web entitlements will be returned along with other existing entitlements in the CustomerInfo object accessible via RevenueCat’s SDK.

If you’re logging in and out of RevenueCat, make sure to resend the Stripe subscription IDs to RevenueCat’s endpoint after logging in.

​

Refreshing of web entitlements

If you aren’t using a Purchase Controller, the SDK will refresh the web entitlements every 24 hours.

​

Redeeming while a paywall is open

If a redeem event occurs when a paywall is open, the SDK will track that as a restore event and the paywall will close.