API reference

BillingFlowParams

Updated: Mar 19, 2025

BillingFlowParams

data class BillingFlowParams(val obfuscatedAccountId: String⁠? = null, val obfuscatedProfileId: String⁠? = null, val isOfferPersonalized: Boolean⁠ = false, val productDetailsParamsList: List⁠<BillingFlowParams.ProductDetailsParams> = emptyList(), val subscriptionUpdateParams: BillingFlowParams.SubscriptionUpdateParams? = null, val skuDetails: SkuDetails? = null)
Parameters to initiate a purchase flow. See BillingClient.launchBillingFlow.
The equivalent Google Play Billing Library class can be found at the Android developer documentation for BillingFlowParams⁠.

Constructors

NameSummary
BillingFlowParams
constructor(obfuscatedAccountId: String⁠? = null, obfuscatedProfileId: String⁠? = null, isOfferPersonalized: Boolean⁠ = false, productDetailsParamsList: List⁠<BillingFlowParams.ProductDetailsParams> = emptyList(), subscriptionUpdateParams: BillingFlowParams.SubscriptionUpdateParams? = null, skuDetails: SkuDetails? = null)

Types

NameSummary
class Builder
Helps to construct BillingFlowParams that are used to initiate a purchase flow.
Companion
object Companion
data class ProductDetailsParams(val productDetails: ProductDetails, val offerToken: String⁠? = null)
Params that describe the product to be purchased and the offer to purchase with.
annotation class ProrationMode
Replace SKU ProrationMode.
class SubscriptionUpdateParams(oldPurchaseToken: String⁠? = null, externalTransactionId: String⁠? = null, subscriptionReplacementMode: Int⁠? = null)
Params that describe a subscription update.

Properties

NameSummary
isOfferPersonalized
val isOfferPersonalized: Boolean⁠ = false
obfuscatedAccountId
val obfuscatedAccountId: String⁠? = null
obfuscatedProfileId
val obfuscatedProfileId: String⁠? = null
productDetailsParamsList
val productDetailsParamsList: List⁠<BillingFlowParams.ProductDetailsParams>
skuDetails
val skuDetails: SkuDetails? = null
subscriptionUpdateParams
val subscriptionUpdateParams: BillingFlowParams.SubscriptionUpdateParams? = null

Companion

object Companion

Properties

NameSummary
EXTRA_PARAM_KEY_ACCOUNT_ID
const val EXTRA_PARAM_KEY_ACCOUNT_ID: String⁠

Functions

NameSummary
newBuilder
fun newBuilder(): BillingFlowParams.Builder