jchucomponents-pay-kmp/com.jeluchu.pay.revenuecat.kmp/Payment

Payment

RevenueCat operations and the small subscription model used by JchuComponents paywalls. The SDK performs the store-specific work through Google Play Billing on Android and StoreKit on iOS; this API can be called from shared Kotlin code.

Types

PaymentProducts

object PaymentProducts

ProductsType

enum ProductsType : Enum<Payment.ProductsType>

Properties

billingError

val billingError: StateFlow<PurchasesError?>

billingInfo

val billingInfo: StateFlow<BillingInfo>

userId

val userId: String

The RevenueCat app user ID. RevenueCat must be configured before reading this property.

Functions

getProducts

fun getProducts()

Loads the current offering and updates billingInfo and billingError.

isSubscriptionActive

fun isSubscriptionActive(onChecked: (Boolean, String) -> Unit = { _, _ -> })

Checks the configured entitlement without refreshing products.

loadBillingInfo

suspend fun loadBillingInfo(): BillingInfo

Loads the current offering and its entitlement details as a suspendable operation.

purchase

fun purchase(type: Payment.ProductsType, onSuccess: (Boolean, String) -> Unit = { _, _ -> }, onFailure: (PurchasesError, Boolean) -> Unit = { _, _ -> })

Purchases the monthly or annual package currently cached in billingInfo.

purchaseResult

suspend fun purchaseResult(type: Payment.ProductsType): Pair<Boolean, String>

Purchases a package and returns whether its configured entitlement became active.

restorePurchases

fun restorePurchases(onRestored: (Boolean, String) -> Unit = { _, _ -> })

Restores purchases associated with the current App Store or Play Store account.

restorePurchasesResult

suspend fun restorePurchasesResult(): Pair<Boolean, String>

setSubscriptionName

fun setSubscriptionName(name: String)

upgradeDownGrade

fun upgradeDownGrade(onSuccess: (Boolean, String) -> Unit = { _, _ -> }, onFailure: (PurchasesError, Boolean) -> Unit = { _, _ -> })

Switches between the monthly and annual packages. Play Store replacement settings are ignored by StoreKit; RevenueCat applies the native store's subscription rules on iOS.