Jump to Content
RevenueCatDocumentationREST APISamplesSDK ReferenceBlogSuggest an EditGet Help
DocumentationREST API
DocumentationREST APISamplesSDK ReferenceBlogSuggest an EditGet HelpSign upLog inRevenueCat
Sign upLog in
DocumentationREST API

😺 Welcome

  • Overview
  • Adding subscriptions to your app
  • Using RevenueCat in existing apps
  • Setting up RevenueCat
    • Invite your team
    • Account security
    • Billing and account settings
  • API Keys & Authentication

🚀 Getting Started

  • SDK Quickstart
  • Configuring Products
    • iOS Product Setup
    • Google Play Product Setup
    • Google Subscriptions and Backwards Compatibility
    • Amazon Product Setup
    • Stripe Product Setup
  • Installing the SDK
    • iOS
    • Android
    • React Native
    • Flutter
    • Cordova
    • Ionic
    • Unity
    • macOS / Catalyst
    • App Builders
  • Configuring the SDK
    • iOS App Extensions
  • Identifying Users
  • Displaying Products
  • Making Purchases
    • Android with Jetpack Compose
  • Checking Subscription Status
  • Restoring Purchases
  • Configuring Server Notifications
  • Stripe Web Payments
    • In-app purchases with Stripe RFA

➡️ Migrating To RevenueCat

  • Migrating Subscriptions
    • Importing Receipts
  • Observer Mode
  • SwiftyStoreKit Migration

👥 Customers

  • Identifying Customers
  • Checking Subscription Status
  • Subscriber Attributes
  • Customer Lists
  • Trusted Entitlements

🧰 Test & Launch

  • Debugging
    • Caching
    • Troubleshooting the SDKs
  • Error Handling
  • Sandbox Testing
    • Apple App Store & TestFlight
    • Google Play Store
    • Amazon Appstore
  • App Subscription Launch Checklist
  • App Store Rejections

💰 Subscription Guidance

  • Free Trials & Promo Offers
    • iOS Subscription Offers
    • Google Play Offers
    • Stripe Free Trials
  • Billing Issues & Grace Periods
  • Upgrades, Downgrades, & Management
  • Changing Prices
  • Handling Refunds
  • Promotional Subscriptions
  • Google Prepaid Plans

📈 Dashboard & Metrics

  • Overview
  • Charts
    • Active Subscriptions Chart
    • Active Subscriptions Movement Chart
    • Churn Chart
    • Refund Rate Chart
    • Annual Recurring Revenue (ARR) Chart
    • Realized LTV per Customer Chart
    • Realized LTV per Paying Customer Chart
    • Monthly Recurring Revenue (MRR) Chart
    • Monthly Recurring Revenue Movement Chart
    • Revenue Chart
    • Conversion to Paying Chart
    • Initial Conversion Chart
    • Trial Conversion Chart
    • Subscription Retention Chart
    • Active Trials Chart
    • Active Trials Movement Chart
    • Charts Feature: Incomplete Periods
  • Customer Lists
  • Customers
    • Customer Details
    • Customer History
    • Active Entitlements
    • Offering Override
    • Promotionals
    • Attributes
    • Attribution
    • App User IDs
    • Deleting Users
  • Taxes and Commissions

🔌 Integrations & Events

  • Events Overview
  • Webhooks
    • Event Types and Fields
    • Common Webhook Flows
    • Sample Events
  • Third Party Integrations
    • Airship
    • Amplitude
    • Braze
    • CleverTap
    • Firebase
    • Intercom
    • Iterable
    • Mixpanel
    • mParticle
    • OneSignal
    • Segment
    • Slack
    • Statsig
    • Superwall
  • Attribution Providers
    • Adjust
    • Apple Search Ads
    • AppsFlyer
    • Branch
    • Facebook Ads
    • SearchAdsHQ
    • Singular
    • SplitMetrics Acquire
    • Tenjin
  • Scheduled Data Exports
    • Amazon S3
    • Google Cloud Storage
    • Data Export Version 3
    • Data Export Version 4
  • Partner-Built Integrations
  • Stripe Dashboard App

🛠 Tools

  • Paywalls (beta)
    • Creating Paywalls
    • Displaying Paywalls
  • Experiments
    • Experiments Overview
    • Creating Offerings to Test
    • Configuring Experiments
    • Experiments Results
  • Offering metadata (beta)
    • Offering metadata example use cases

📙 Platform Resources

  • Implementation Responsibilities
  • Amazon Platform Resources
    • Amazon Small Business Accelerator Program
  • Apple Platform Resources
    • Apple App Privacy
    • App Store Small Business Program
    • Using RevenueCat with SwiftUI
    • Apple Family Sharing
    • Legacy Mac Apps
  • Google Platform Resources
    • Google Play Pass
    • 15% Reduced Service Fee
    • Google Play's Data Safety
    • Google Play Quota Increase Request
  • Non-Subscription Purchases
  • Platform Server Notifications
    • Apple App Store Server Notifications
    • Google Real-Time Developer Notifications
    • Stripe Server Notifications
  • No and Low Code App Builders
  • Sample Apps

🔑 Service Credentials

  • Apple App Store
    • In-App Purchase Key Configuration
    • App Store Connect API Key Configuration
  • Google Play Store
    • Google Play Checklists
  • Amazon Appstore

🛟 RevenueCat Support

  • 🔢 Support First Steps

📘 SDK Guides

  • SDK Migration Guides
    • iOS Native - 3.x to 4.x Migration
    • Android Native - 4.x to 5.x Migration
    • Android Native - 5.x to 6.x Migration
    • Android Native - 6.x to 7.x Migration

SDK Reference

The API reference documentation provides detailed information for each of the classes and methods in the RevenueCat SDK. Choose your platform from the list below.

iOS Reference

Android Reference

Flutter Reference

React Native Reference

Capacitor Reference

Cordova Reference

Updated 4 days ago