RevenueCat

Build With RevenueCat

Build a customized mobile subscription business with RevenueCat. We do the heavy lifting of normalizing subscribers from any source and maintain a single source of truth for subscription status, so you can get back to building your app.

RevenueCat is a powerful, secure, reliable, and free to use in-app purchase server with global support. All you need to get started is an API key.

Get Started    API Reference

Migrating Subscriptions

How to migrate subscriptions from your existing setup

If you already have an existing app that is using subscriptions, it's easy to migrate them over to RevenueCat. You can use the Purchases SDK to replace all of your in-app-purchase code, or you can just use it along side your current stack to track in-app-purchases and benefit from our charting, webhooks, and other integrations.

Client Side Migration

👍

This section assumes you've followed our Quickstart section of our Getting Started guide to install and configure our SDK.

The Purchases SDK automatically detects new transactions and sends them to RevenueCat. However, when migrating from an older system, you need to tell Purchases to sync to ensure we are tracking your subscribers correctly.

The way to do this is: if your existing subscription code knows you have a subscription, but RevenueCat does not, then restore transactions.

See the following pseudo example.

const isSubscribedInOldSystem = oldTracking.isSubscribed()
const isSubscribedInRevenueCat = !purchaserInfo.entitlements.active.isEmpty

// If the old system says we have a subscription, but RevenueCat does not
if (isSubscribedInOldSystem && !isSubscribedInRevenueCat) 
{
  // Tell Purchases to restoreTransactions. 
  // This will sync the user's receipt with RevenueCat.
  Purchases.shared.restoreTransactions { (purchaserInfo, error) in }
}

When a subscriber launches with the first version containing Purchases it will trigger a restore. Once the restore is complete, it won't be triggered again.

📘

Do not restore on every app launch

It's okay to trigger a restore once per subscriber programmatically the first time they open a version of your app containing RevenueCat. You should not call restore programmatically on every app launch for every user. This can increase latency in your app and unintentionally alias users together.

Use RevenueCat Backend Only (Observer Mode)

In some cases, if you have already built a functioning subscription system, it may not be possible or feasible to use the Purchases SDK to make purchases. However, you can still use the SDK to get access to the advanced charting, webhooks, and attribution that RevenueCat can provide.

Check our guide on Observer Mode for details on setting this up.

Importing Existing Data

Using the REST API

If you have the correct data saved already for your users, you can import them through the REST API POST /receipts endpoint. This will create the user in RevenueCat and start tracking their subscription status.

More info in the API Reference here.

Bulk imports

For large datasets that aren't practical to import through the REST API, you can send us a .csv file to import manually. Email us with the below information and we'll be in touch.

📘

Bulk imports DO NOT trigger webhooks or integrations

Bulk imports done by RevenueCat will not trigger any webhook or integration events. If this is a requirement, then you'll need to perform an import using the REST API as mentioned above.

To do a receipt import we'll need 3 csv files for iOS, Android and Stripe with the following fields:

iOS:

  • app_user_id
  • receipt (the raw receipt file)
  • product_id
  • price
  • introductory_price (if not a free trial)
  • currency

*If you don't have prices and currency with the transactions we can take a separate file with a mapping of product_id, price, currency as well. If there were any known price changes, those should also be included here.

Android:

  • app_user_id
  • product_id
  • token

Important: We need to know your API quota with Google and approximately how many remaining requests per day you have so we don't exceed your quota.

*Note that Android receipts that expired more than 90 days ago can't be imported, and more than 90 days of history can't be retrieved from each Android receipt. This means that Android charts for historical data won't be accurate.

Stripe:

  • app_user_id
  • subscription_token (e.g. sub_xxxxxx)

📘

Allow up to 7-days for bulk imports

Depending on the size of your import and the current queue, please allow up to a week for your import to be processed.

Next Steps

Updated 2 months ago


Migrating Subscriptions


How to migrate subscriptions from your existing setup

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.