Documentation

API reference

The public PaywallReady Kit API buyers will use most after setup.

PaywallReadyProvider

Prop
Type
Purpose
iosApiKey
string
RevenueCat iOS SDK key.
androidApiKey
string
RevenueCat Android SDK key.
entitlementId
string
Entitlement to check, such as pro.
authAdapter
optional
Maps your logged-in user to RevenueCat app user id.

usePremium()

Value
Type
Purpose
isPremium
boolean
True when the entitlement is active.
isLoading
boolean
True while customer info or offerings load.
presentPaywall
function
Opens the paywall.
purchasePackage
async
Purchases a RevenueCat package.
restorePurchases
async
Restores previous purchases.
refresh
async
Reloads customer info and entitlement status.

Components and helpers

  • PaywallScreen is the purchasable UI.
  • PremiumGate shows locked UI when the user is not premium.
  • createAuthAdapter creates a stable user-id bridge for auth providers.
  • anonymousAuthAdapter can be used for explicit anonymous behavior.

← Previous

Expo testing

Next →

Troubleshooting