|
| 1 | +# RevenueCat Documentation |
| 2 | + |
| 3 | +This file provides an organized guide to RevenueCat's documentation for large language models. RevenueCat is a platform that makes it easy to build, analyze, and grow in-app purchases and subscriptions on iOS, Android, and the web—no server code required. |
| 4 | + |
| 5 | +The prefix for the URL paths is: https://www.revenuecat.com/docs |
| 6 | + |
| 7 | +## Overview and Getting Started |
| 8 | + |
| 9 | +- /welcome/overview - Platform introduction and core concepts of RevenueCat |
| 10 | +- /welcome/building-new - Adding subscriptions to your app for the first time |
| 11 | +- /welcome/existing-apps - Migrating existing subscription apps to RevenueCat |
| 12 | +- /getting-started/quickstart - Complete setup guide from account creation to first purchase |
| 13 | +- /getting-started/installation - SDK installation guides for all supported platforms |
| 14 | +- /getting-started/configuring-sdk - SDK configuration and initialization best practices |
| 15 | +- /getting-started/entitlements - Product configuration, entitlements, and offerings system |
| 16 | +- /getting-started/displaying-products - How to display products and pricing to customers |
| 17 | +- /getting-started/making-purchases - Implementation guide for purchase flows |
| 18 | +- /getting-started/restoring-purchases - Restore purchases functionality across devices |
| 19 | + |
| 20 | +## SDK Implementation Guides |
| 21 | + |
| 22 | +- /getting-started/installation/ios - iOS and Apple Platforms SDK installation |
| 23 | +- /getting-started/installation/android - Android SDK installation and setup |
| 24 | +- /getting-started/installation/flutter - Flutter cross-platform installation |
| 25 | +- /getting-started/installation/reactnative - React Native installation guide |
| 26 | +- /getting-started/installation/unity - Unity game engine integration |
| 27 | +- /getting-started/installation/cordova - Cordova mobile app framework setup |
| 28 | +- /getting-started/installation/capacitor - Capacitor (Ionic) hybrid app setup |
| 29 | +- /getting-started/installation/macos - macOS and Catalyst installation |
| 30 | +- /getting-started/installation/expo - Expo React Native framework setup |
| 31 | +- /getting-started/installation/app-builders - No-code and low-code app builders |
| 32 | + |
| 33 | +## SDK Migration Guides |
| 34 | + |
| 35 | +- /sdk-guides/ios-native-3x-to-4x-migration - iOS SDK migration from 3.x to 4.x |
| 36 | +- /sdk-guides/ios-native-4x-to-5x-migration - iOS SDK migration from 4.x to 5.x |
| 37 | +- /sdk-guides/android-native-4x-to-5x-migration - Android SDK version migration |
| 38 | +- /sdk-guides/android-native-5x-to-6x-migration - Android SDK 5.x to 6.x migration |
| 39 | +- /sdk-guides/android-native-6x-to-7x-migration - Android SDK 6.x to 7.x migration |
| 40 | +- /sdk-guides/android-native-7x-to-8x-migration - Android SDK 7.x to 8.x migration |
| 41 | + |
| 42 | +## API Reference |
| 43 | + |
| 44 | +- /api-v1/ - REST API v1 complete reference documentation |
| 45 | +- /api-v2/ - REST API v2 complete reference documentation |
| 46 | +- /api-v2-beta/ - Beta API features and endpoints |
| 47 | +- /external-purchases-api-beta/ - External purchases API for alternative payment methods |
| 48 | + |
| 49 | +## Core Features and Tools |
| 50 | + |
| 51 | +- /tools/paywalls - Remote paywall configuration and management |
| 52 | +- /tools/paywalls/displaying-paywalls - How to present paywalls in your app |
| 53 | +- /tools/paywalls/creating-paywalls - Building and customizing paywalls |
| 54 | +- /tools/experiments-v1 - A/B testing framework for pricing optimization |
| 55 | +- /tools/experiments-v1/creating-offerings-to-test - Setting up price testing experiments |
| 56 | +- /tools/targeting - Customer targeting and segmentation tools |
| 57 | +- /tools/offering-metadata - Dynamic paywall configuration with metadata |
| 58 | +- /tools/customer-center/customer-center-integration-ios - iOS customer support center |
| 59 | + |
| 60 | +## RevenueCat MCP Server (Model Context Protocol) |
| 61 | + |
| 62 | +- /tools/mcp - Complete MCP server overview and setup guide |
| 63 | +- /tools/mcp/overview - What MCP is and deployment options (cloud vs local) |
| 64 | +- /tools/mcp/setup - Configure MCP server for cloud or local VS Code/Cursor extension |
| 65 | +- /tools/mcp/tools-reference - Complete reference for all 26 MCP server tools |
| 66 | +- /tools/mcp/usage-examples - Natural language interaction examples with MCP |
| 67 | +- /tools/mcp/best-practices-and-troubleshooting - Security and troubleshooting guide |
| 68 | + |
| 69 | +## Product and Offering Management |
| 70 | + |
| 71 | +- /offerings - Product offering management and configuration |
| 72 | +- /offerings/overview - Offerings system concepts and setup |
| 73 | +- /offerings/products-overview - Individual product configuration |
| 74 | +- /offerings/troubleshooting-offerings - Debugging empty products and offerings |
| 75 | +- /offerings/virtual-currency/subscriptions - Virtual currency grants for subscriptions |
| 76 | +- /offerings/virtual-currency/refunds - Virtual currency balance adjustments for refunds |
| 77 | + |
| 78 | +## Customer Management |
| 79 | + |
| 80 | +- /customers/customer-info - Customer data and subscription status management |
| 81 | +- /customers/user-ids - User identification and authentication patterns |
| 82 | +- /customers/customer-attributes - Custom data and device identifiers |
| 83 | +- /customers/trusted-entitlements - Enhanced security for entitlement verification |
| 84 | + |
| 85 | +## Analytics and Data |
| 86 | + |
| 87 | +- /dashboard-and-metrics/overview - Revenue analytics and business metrics overview |
| 88 | +- /dashboard-and-metrics/charts - Chart types and metrics visualization |
| 89 | +- /dashboard-and-metrics/charts/app-store-refund-requests-chart - Apple refund request analytics |
| 90 | +- /dashboard-and-metrics/customer-history - Individual customer purchase tracking |
| 91 | +- /dashboard-and-metrics/customer-lists - Customer segmentation and analysis tools |
| 92 | +- /dashboard-and-metrics/customer-history/active-entitlements - Managing active subscriptions |
| 93 | +- /dashboard-and-metrics/customer-history/manage-users - Customer account management |
| 94 | + |
| 95 | +## Integrations and Webhooks |
| 96 | + |
| 97 | +- /integrations/integrations - Third-party platform integration overview |
| 98 | +- /integrations/webhooks - Real-time event notification system |
| 99 | +- /integrations/third-party-integrations - Analytics and marketing tool connections |
| 100 | +- /integrations/attribution - Marketing attribution and analytics setup |
| 101 | +- /integrations/attribution/apple-search-ads - Apple Search Ads attribution setup |
| 102 | +- /integrations/stripe-app - Direct Stripe integration for payment processing |
| 103 | +- /integrations/scheduled-data-exports - Automated data export configuration |
| 104 | +- /integrations/data-onboarding - Data integration setup and configuration |
| 105 | +- /integrations/partner-built-integrations - Partner-developed integration solutions |
| 106 | + |
| 107 | +## Testing and Debugging |
| 108 | + |
| 109 | +- /test-and-launch/debugging - View and understand Purchases SDK logs |
| 110 | +- /test-and-launch/debugging/troubleshooting-the-sdks - Common SDK issues and solutions |
| 111 | +- /test-and-launch/debugging/caching - How caching works in RevenueCat |
| 112 | +- /test-and-launch/errors - Error handling and error code reference |
| 113 | +- /test-and-launch/sandbox - Sandbox testing environments for stores |
| 114 | +- /test-and-launch/sandbox/apple-app-store - iOS sandbox testing guide |
| 115 | +- /test-and-launch/sandbox/google-play-store - Android sandbox testing guide |
| 116 | +- /test-and-launch/launch-checklist - Pre-launch validation and testing checklist |
| 117 | +- /test-and-launch/app-store-rejections - Common app store rejection reasons |
| 118 | + |
| 119 | +## Platform Setup and Configuration |
| 120 | + |
| 121 | +- /service-credentials/itunesconnect-app-specific-shared-secret - App Store Connect credentials |
| 122 | +- /service-credentials/itunesconnect-app-specific-shared-secret/in-app-purchase-key-configuration - Apple in-app purchase key setup |
| 123 | +- /service-credentials/itunesconnect-app-specific-shared-secret/app-store-connect-api-key-configuration - App Store Connect API key configuration |
| 124 | +- /service-credentials/creating-play-service-credentials - Google Play Developer API setup |
| 125 | +- /service-credentials/creating-play-service-credentials/google-play-checklists - Google Play troubleshooting checklists |
| 126 | +- /service-credentials/amazon-appstore-credentials - Amazon Appstore integration setup |
| 127 | +- /projects/overview - Project creation and management |
| 128 | +- /projects/authentication - API key management and security |
| 129 | +- /projects/connect-a-store - Connecting apps to app stores |
| 130 | + |
| 131 | +## Platform-Specific Resources |
| 132 | + |
| 133 | +### Apple Platform Resources |
| 134 | +- /platform-resources/apple-platform-resources - Apple platforms development resources |
| 135 | +- /platform-resources/apple-platform-resources/apple-app-privacy - App privacy disclosure requirements |
| 136 | +- /platform-resources/apple-platform-resources/app-store-small-business-program - Small business program enrollment |
| 137 | +- /platform-resources/apple-platform-resources/apple-family-sharing - Family sharing subscription support |
| 138 | +- /platform-resources/apple-platform-resources/handling-refund-requests - Apple refund request handling |
| 139 | +- /platform-resources/apple-platform-resources/legacy-mac-apps - Legacy Mac app configuration |
| 140 | + |
| 141 | +### Google Platform Resources |
| 142 | +- /platform-resources/google-platform-resources - Google platform development resources |
| 143 | +- /platform-resources/google-platform-resources/google-play-pass - Google Play Pass program integration |
| 144 | +- /platform-resources/google-platform-resources/google-plays-data-safety - Data safety form requirements |
| 145 | + |
| 146 | +### Amazon Platform Resources |
| 147 | +- /platform-resources/amazon-platform-resources - Amazon Appstore development resources |
| 148 | +- /platform-resources/amazon-platform-resources/amazon-small-business-accelerator-program - Amazon small business program |
| 149 | + |
| 150 | +## Server Notifications |
| 151 | + |
| 152 | +- /platform-resources/server-notifications/apple-server-notifications - Apple App Store server notifications |
| 153 | +- /platform-resources/server-notifications/google-server-notifications - Google Play server notifications |
| 154 | +- /platform-resources/server-notifications/stripe-server-notifications - Stripe webhook configuration |
| 155 | + |
| 156 | +## Subscription Management and Business Logic |
| 157 | + |
| 158 | +- /subscription-guidance/subscription-offers - Free trials and promotional offers |
| 159 | +- /subscription-guidance/subscription-offers/ios-subscription-offers - Apple subscription offers and trials |
| 160 | +- /subscription-guidance/subscription-offers/google-play-offers - Google Play subscription offers |
| 161 | +- /subscription-guidance/refunds - Handling refunds across platforms |
| 162 | +- /subscription-guidance/price-changes - Managing subscription price changes |
| 163 | +- /subscription-guidance/google-prepaid-plans - Google Play prepaid subscription plans |
| 164 | +- /subscription-guidance/managing-subscriptions - Subscription lifecycle management |
| 165 | + |
| 166 | +## Migration and Advanced Topics |
| 167 | + |
| 168 | +- /migrating-to-revenuecat/migration-paths - Migration strategies for existing subscription apps |
| 169 | +- /migrating-to-revenuecat/migrating-existing-subscriptions - Handling existing subscriber base |
| 170 | +- /migrating-to-revenuecat/current-subscriptions - Migrating active subscriptions |
| 171 | +- /migrating-to-revenuecat/swiftystorekit - Migrating from SwiftyStoreKit to RevenueCat |
| 172 | +- /migrating-to-revenuecat/sdk-or-not/finishing-transactions - Transaction completion configuration |
| 173 | +- /migrating-to-revenuecat/sdk-or-not/sdk-less-integration - Using RevenueCat without SDK |
| 174 | + |
| 175 | +## Web and Alternative Platforms |
| 176 | + |
| 177 | +- /web/purchases-hybrid-app - Web-based subscription implementation |
| 178 | +- /web/stripe-setup - Stripe integration for web subscriptions |
| 179 | +- /web/connect-stripe-account - Connecting your Stripe account |
| 180 | +- /web/integrations/stripe - Stripe checkout and payment processing |
| 181 | +- /getting-started/entitlements/stripe-products - Stripe product configuration |
| 182 | +- /getting-started/entitlements/paddle-products - Paddle payment provider setup |
| 183 | +- /getting-started/entitlements/ios-products - iOS product setup in App Store Connect |
| 184 | +- /getting-started/entitlements/android-products - Android product setup in Google Play |
| 185 | +- /getting-started/entitlements/amazon-product-setup - Amazon Appstore product configuration |
| 186 | + |
| 187 | +## Non-Subscription Purchases |
| 188 | + |
| 189 | +- /platform-resources/non-subscriptions - Using RevenueCat beyond subscriptions |
| 190 | +- /platform-resources/implementation-responsibilities - Developer vs RevenueCat responsibilities |
| 191 | +- /platform-resources/developer-store-payments - Store payout information and country availability |
| 192 | + |
| 193 | +## Sample Apps and Code Examples |
| 194 | + |
| 195 | +- /platform-resources/sample-apps - Example apps for all supported platforms |
| 196 | +- /platform-resources/sdk-reference - SDK API reference documentation |
| 197 | + |
| 198 | +## Playbooks and Business Guidance |
| 199 | + |
| 200 | +- /playbooks/overview - Implementation playbooks and best practices |
| 201 | +- /playbooks/guides/freemium - Freemium paywall strategy implementation |
| 202 | +- /playbooks/guides/hard-paywall - Hard paywall strategy implementation |
| 203 | + |
| 204 | +## Support and Troubleshooting |
| 205 | + |
| 206 | +- /revenuecat-support/support-first-steps - Getting help and support resources |
| 207 | +- /revenuecat-support/general-troubleshooting - Common issues and solutions |
| 208 | + |
| 209 | +## Known Issues |
| 210 | + |
| 211 | +- /known-store-issues/storekit - Known Apple StoreKit framework issues |
| 212 | +- /known-store-issues/storekit/ios-18-4-simulator-fails-to-load-products - iOS simulator product loading issues |
| 213 | + |
| 214 | +## Developer Tools and Testing |
| 215 | + |
| 216 | +- /guides/testing-guide/use-cases - Testing scenarios and validation steps |
| 217 | +- /guides/subscription-offers - Advanced pricing strategies and promotional offers |
| 218 | +- /guides/environment-strategies - Managing multiple development environments |
0 commit comments