2.8.0

CHANGELOG.md

@@ -2,6 +2,32 @@
 
 The changelog for `Superwall`. Also see the [releases](https://github.com/superwall/Superwall-Android/releases) on GitHub.
 
+## 2.8.0
+
+## Enhancements
+- Updates Google Play Billing Library from 8.0.0 to 9.1.0. See the [Play Billing Library 9 migration guide](https://developer.android.com/google/play/billing/migrate-gpblv9) for the full list of changes.
+- Updates the RevenueCat SDK used by the sample apps from 9.2.0 to 10.14.1 for Billing 9 compatibility.
+- Adds support for custom store products. Products configured on a custom store in the Superwall dashboard (e.g. Stripe or your own payment backend) can now be attached to paywalls: their metadata (price, subscription period, trial) is fetched from the Superwall API instead of Google Play and templated into the paywall like any other product. Purchases are routed through your `PurchaseController`, bypassing Google Play Billing entirely — check `product.isCustomProduct` to fulfill them via your own payment flow, and grant their entitlements with `Superwall.instance.setSubscriptionStatus(...)` on success. Requires configuring the SDK with a `PurchaseController`.
+- Adds a unified `PurchaseController.purchase(activity, product: StoreProduct, basePlanId, offerId)` method that handles both Google Play and custom store products. For Play products, the underlying `ProductDetails` are available via `product.rawStoreProduct`.
+- Custom purchases produce full transaction analytics (`transaction_start`/`transaction_complete`, `subscriptionStart`/`freeTrialStart`) with an SDK-generated transaction identifier exposed as `StoreProduct.customTransactionId`, and free-trial eligibility for custom products is derived from the customer's entitlement history.
+- Adds `ApiStoreProduct`, a product backed by Superwall API data, used for custom store products. 
+
+## Breaking Changes
+- System back presses are now forwarded into the paywall as a `back_button_input` message instead of dismissing it directly: multi-page flows navigate back one page, and paywalls with nowhere to go back (root page, single page) close themselves through the standard manual-close path (`Declined`/`ManualClose`) — so single-page paywalls dismiss the same as before, from the app's perspective. When `reroute_back_button` is enabled in Paywall settings, the `PaywallOptions.onBackPressed` app callback keeps first refusal before the press is forwarded. Paywalls built on runtimes that predate `back_button_input` will ignore the press; make sure paywalls are re-published on a current runtime.
+- Removes the deprecated `SuperwallBillingFlowParams.Builder.setSkuDetails(SkuDetails)`. Billing Library 9 removes `SkuDetails` entirely, so this method can no longer exist. Use `setProductDetailsParamsList(...)` with `ProductDetails` instead.
+- Removes the unused internal `com.superwall.sdk.billing.SWProduct`, which wrapped the now-removed `SkuDetails`.
+- Internal purchase-history queries now resolve current purchases via `QueryPurchasesParams` — Billing Library 9 removes the purchase-history APIs (`queryPurchaseHistoryAsync`, `QueryPurchaseHistoryParams`).
+- **Impact:** if your app still calls the removed Billing Library APIs (`SkuDetails`, `SkuDetailsParams`, `querySkuDetailsAsync`, `queryPurchaseHistoryAsync`, `BillingClient.SkuType`, or the no-arg `enablePendingPurchases()`), it will no longer compile once it picks up Billing 9 through this SDK. Migrate those call sites to the `ProductDetails` APIs before upgrading; the [migration guide](https://developer.android.com/google/play/billing/migrate-gpblv9) has a mapping of every removed API to its replacement.
+- **Please test your billing and purchasing flows before shipping this upgrade.** Because the Billing Library is resolved to a single version across your app, upgrading Superwall also upgrades Billing for everything else that depends on it. If you use Google Play Billing directly, or another subscription provider such as RevenueCat, Adapty or Qonversion, make sure that provider's SDK supports Billing 9 and run through purchase, restore and subscription-status flows end to end.
+
+## ⚠️ Minimum SDK version raised to 23
+
+Google Play Billing Library 9 requires Android 6.0 (API 23), so the SDK's `minSdk` is now **23** (previously 21). If your app's `minSdk` is below 23, you'll need to raise it to pick up this release — devices on Android 5.x will no longer receive app updates that include this SDK version.
+
+## Deprecations
+
+- Deprecates `PurchaseController.purchase(activity, productDetails, basePlanId, offerId)` in favor of the `StoreProduct`-based method above. Existing implementations keep working unchanged — the new method's default implementation routes Google Play purchases to the deprecated one — but purchasing custom store products requires implementing the new method.
+
 ## 2.7.23
 
 ## Fixes

app/build.gradle.kts

@@ -12,7 +12,7 @@ android {
 
     defaultConfig {
         applicationId = "com.superwall.superapp"
-        minSdk = 22
+        minSdk = 23
         targetSdk = 34
         versionCode = 2
         versionName = "1.0.0"

app/src/main/java/com/superwall/superapp/purchase/RevenueCatPurchaseController.kt

@@ -2,6 +2,7 @@ package com.superwall.superapp.purchase
 
 import android.app.Activity
 import android.content.Context
+import android.util.Log
 import com.android.billingclient.api.ProductDetails
 import com.revenuecat.purchases.CustomerInfo
 import com.revenuecat.purchases.LogLevel
@@ -27,11 +28,14 @@ import com.superwall.sdk.delegate.RestorationResult
 import com.superwall.sdk.delegate.subscription_controller.PurchaseController
 import com.superwall.sdk.models.entitlements.Entitlement
 import com.superwall.sdk.models.entitlements.SubscriptionStatus
+import com.superwall.sdk.store.Entitlements
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
+import kotlin.String
+import kotlin.collections.mutableListOf
 
 // Extension function to convert callback to suspend function
 suspend fun Purchases.awaitProducts(productIds: List<String>): List<StoreProduct> {
@@ -115,8 +119,10 @@ class RevenueCatPurchaseController(
     UpdatedCustomerInfoListener {
     private var superwallCustomerInfoJob: Job? = null
     private val scope = CoroutineScope(Dispatchers.Main)
+    val purchased: MutableList<String>
 
     init {
+        purchased = mutableListOf<String>()
         Purchases.logLevel = LogLevel.DEBUG
         Purchases.configure(
             PurchasesConfiguration
@@ -175,7 +181,7 @@ class RevenueCatPurchaseController(
                 emptySet()
             }
 
-        val allEntitlements = rcEntitlements + webEntitlements
+        val allEntitlements = rcEntitlements + webEntitlements + purchased.map { Entitlement(it) }
 
         if (allEntitlements.isNotEmpty()) {
             setSubscriptionStatus(SubscriptionStatus.Active(allEntitlements))
@@ -189,10 +195,27 @@ class RevenueCatPurchaseController(
      */
     override suspend fun purchase(
         activity: Activity,
-        productDetails: ProductDetails,
+        product: com.superwall.sdk.store.abstractions.product.StoreProduct,
         basePlanId: String?,
         offerId: String?,
     ): PurchaseResult {
+        // Custom store products aren't on Google Play — fulfill them through your own
+        // payment flow and grant the entitlements yourself.
+        if (product.isCustomProduct) {
+            // Example only, save the entitlements to storage here to persist
+            purchased.add("custom_entitlement")
+
+            // Sync your subscription status
+            Purchases.sharedInstance.getCustomerInfoWith {
+                updateSubscriptionStatus(it)
+            }
+            return PurchaseResult.Purchased()
+        }
+
+        val productDetails =
+            product.rawStoreProduct?.underlyingProductDetails
+                ?: return PurchaseResult.Failed("Missing product details for ${product.fullIdentifier}")
+
         // Find products matching productId from RevenueCat
         val products = Purchases.sharedInstance.awaitProducts(listOf(productDetails.productId))
         // Choose the product which matches the given base plan.

example/app/build.gradle.kts

@@ -10,7 +10,7 @@ android {
 
     defaultConfig {
         applicationId = "com.superwall.superapp"
-        minSdk = 22
+        minSdk = 23
         targetSdk = 34
         versionCode = 1
         versionName = "1.0.0"

gradle/libs.versions.toml

@@ -1,13 +1,13 @@
 [versions]
-billing_version = "8.0.0"
+billing_version = "9.1.0"
 browser_version = "1.8.0"
 gradle_plugin_version = "8.6.1"
 jna_version = "5.14.0@aar"
 kotlinxCoroutinesGuavaVersion = "1.9.0"
 leakcanaryAndroidVersion = "2.14"
 lifecycleProcessVersion = "2.8.5"
 orchestratorVersion = "1.5.0"
-revenue_cat_version = "9.2.0"
+revenue_cat_version = "10.14.1"
 compose_version = "2024.12.01"
 kotlinx_serialization_json_version = "1.7.2"
 activity_compose_version = "1.9.3"

superwall-compose/build.gradle.kts

@@ -18,7 +18,7 @@ android {
     compileSdk = 35
 
     defaultConfig {
-        minSdk = 22
+        minSdk = 23
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
 

superwall/build.gradle.kts

@@ -31,7 +31,7 @@ android {
     namespace = "com.superwall.sdk"
 
     defaultConfig {
-        minSdkVersion(21)
+        minSdkVersion(23)
         targetSdkVersion(33)
 
         aarMetadata {

superwall/src/androidTest/java/com/superwall/sdk/analytics/internal/TrackingLogicTest.kt

@@ -57,6 +57,12 @@ class TrackingLogicTest {
 
                                 override suspend fun makeStoreTransaction(transaction: Purchase): StoreTransaction = mockk()
 
+                                override suspend fun makeStoreTransaction(
+                                    customTransactionId: String,
+                                    productIdentifier: String,
+                                    purchaseDate: java.util.Date,
+                                ): StoreTransaction = mockk()
+
                                 override suspend fun activeProductIds(): List<String> = emptyList()
 
                                 override suspend fun makeIdentityManager(): IdentityManager = mockk()

superwall/src/androidTest/java/com/superwall/sdk/store/transactions/TransactionManagerTest.kt

@@ -294,7 +294,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -400,7 +400,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -525,7 +525,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -581,7 +581,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -631,7 +631,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -676,7 +676,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -722,7 +722,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         any(),
                         any(),
                     )
@@ -911,7 +911,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -957,7 +957,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         any(),
                         any(),
                     )
@@ -1002,7 +1002,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         any(),
                         any(),
                     )
@@ -1050,7 +1050,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )
@@ -1098,7 +1098,7 @@ class TransactionManagerTest {
                 coEvery {
                     purchaseController.purchase(
                         any(),
-                        any(),
+                        any<StoreProduct>(),
                         "basePlan",
                         any(),
                     )

superwall/src/main/java/com/superwall/sdk/billing/BillingClientParamBuilders.kt

@@ -2,14 +2,13 @@ package com.superwall.sdk.billing
 
 import com.android.billingclient.api.BillingClient
 import com.android.billingclient.api.QueryProductDetailsParams
-import com.android.billingclient.api.QueryPurchaseHistoryParams
 import com.android.billingclient.api.QueryPurchasesParams
 
-internal fun @receiver:BillingClient.ProductType String.buildQueryPurchaseHistoryParams(): QueryPurchaseHistoryParams? =
+internal fun @receiver:BillingClient.ProductType String.buildQueryPurchaseHistoryParams(): QueryPurchasesParams? =
     when (this) {
         BillingClient.ProductType.INAPP,
         BillingClient.ProductType.SUBS,
-        -> QueryPurchaseHistoryParams.newBuilder().setProductType(this).build()
+        -> QueryPurchasesParams.newBuilder().setProductType(this).build()
         else -> null
     }
 

superwall/src/main/java/com/superwall/sdk/billing/observer/SuperwallBillingFlowParams.kt

@@ -2,7 +2,6 @@ package com.superwall.sdk.billing.observer
 
 import com.android.billingclient.api.BillingFlowParams
 import com.android.billingclient.api.ProductDetails
-import com.android.billingclient.api.SkuDetails
 
 class SuperwallBillingFlowParams private constructor(
     internal val params: BillingFlowParams,
@@ -39,12 +38,6 @@ class SuperwallBillingFlowParams private constructor(
                 builder.setProductDetailsParamsList(productDetailsParamsList.map { it.toOriginal() })
             }
 
-        @Deprecated("Use setProductDetailsParamsList instead")
-        fun setSkuDetails(skuDetails: SkuDetails): Builder =
-            apply {
-                builder.setSkuDetails(skuDetails)
-            }
-
         fun setSubscriptionUpdateParams(params: SubscriptionUpdateParams): Builder =
             apply {
                 builder.setSubscriptionUpdateParams(params.toOriginal())