This guide will walk you through how to get up and running with subscriptions and RevenueCat's SDK with only a few lines of code.

# 1. Create a RevenueCat Account

Sign up for a new RevenueCat account [here](🔗).

💡 Here's a tip!

We recommend creating a separate RevenueCat account for each app / project you have, especially if you ever intend on selling the app. This will speed up the transfer process, since you can transfer the entire account rather than waiting for RevenueCat Support to transfer individual projects.

### Organizations / Enterprise

We recommend using a company account when registering for RevenueCat and setting up your app within a project. You'll be able to invite the rest of your team as [collaborators](🔗) to your project, but **only the project owner can manage billing**. Project collaborators can't manage billing details.

# 2. Project and App Configuration

## ▶️ Create a Project

Navigate to the RevenueCat dashboard and [add a new project ](🔗) from the dropdown in the top navigation menu called _Projects_.


The popup modal for creating a new Project

## ▶️ Add an App / Platform

From **Project Settings > Apps** in the left menu of the project dashboard, select the platform for the app you will be adding.


Project dashboard for selecting the app platform

The field **App name** is required to add your app to RevenueCat. To make test and production purchases, the **Bundle ID** (iOS) / **Package Name** (Android) as well as the **Shared Secret** (iOS) / **Service Credentials** (Android) **must be configured**.

If you try making purchases without a bundle ID and valid credentials, the SDK will fail with a '[receipt is not valid](🔗)' error as RevenueCat will be unable to validate the transaction with the store.

The rest of the configuration fields can be added later.


App configuration page for an Apple App Store app

💡 Here's a tip!

After registering your app, we recommend setting up [Platform Server Notifications](🔗). These notifications aren't required but will speed up [webhooks](🔗) and integration delivery times and reduce lag time updating your subscribers.

Staging vs. Production apps and users

RevenueCat itself does not have separate environments for staging and production. Rather, the underlying transactions for users are differentiated by sandbox and production.

Any RevenueCat app can make both sandbox and production purchases from the stores. If you do have separate apps for staging and production, you can create multiple projects in RevenueCat to mirror your setup.

Furthermore, users are not separated by environment, either. The same user can have active sandbox purchases and active production purchases at the same time.

## ▶️ Service Credentials

Service credentials need to be set up for RevenueCat to communicate with the app stores on your behalf. See our guides [App Store Connect Shared Secret](🔗), [Play Service Credentials](🔗), and [Amazon Appstore Shared Secret](🔗) for more information.

Note that Play service credentials can take up to 36 hours to propagate throughout Google's servers.

# 3. Product Configuration

## ▶️ Store Setup

Before you can start using RevenueCat to fetch products, you must configure your products in the respective stores. See the following guides for [App Store Connect](🔗), [Google Play Console](🔗), [Amazon Appstore](🔗), and [Stripe](🔗) for help navigating through this process.

If you are selling iOS products, be sure to sign your 'Paid Applications Agreement' and fill out your bank and tax information in **App Store Connect > Agreements, Tax, and Banking**. **This needs to be completed before you can test any purchases**.

Want to skip the store setup while testing?

On iOS, you can delay configuring products in App Store Connect by testing with StoreKit Configuration files instead. These config files require minimal setup and are configurable via Xcode directly.

Read more about setting up StoreKit Configuration files in our [Sandbox Testing](🔗) guide.

## ▶️ Configure Products and Entitlements in RevenueCat

Once your in-app products have been configured in [App Store Connect](🔗), [Google Play Console](🔗), [Amazon Appstore](🔗), or [Stripe](🔗), you'll need to copy that configuration into the RevenueCat dashboard. RevenueCat uses an Entitlements system to control access to premium features, and Offerings to manage the set of products you offer to customers.

Entitlements are the level of access that a customer is "entitled" to after purchasing a specific product, and Offerings is a simple way for you to organize the in-app products you wish to "offer" on your paywall and configure them remotely. We **recommend** utilizing these features to simplify your code and enable you to change products without releasing an app update.

See [Configuring Products](🔗) to set up your products and then organize them into Offerings or Entitlements.


# 4. Using RevenueCat's Purchases SDK

Our SDK seamlessly implements purchases and subscriptions across platforms while syncing tokens with the RevenueCat server.

## ▶️ Installation

Install the SDK on your preferred platform with our installation guides below.

  • [iOS Installation ](🔗)

  • [Android Installation ](🔗)

  • [React Native Installation ](🔗)

  • [Flutter Installation ](🔗)

  • [Cordova Installation ](🔗)

  • [Ionic Installation ](🔗)

  • [Unity Installation ](🔗)

  • [macOS / Catalyst Installation ](🔗)

If you run into issues with the SDK, see [Troubleshooting the SDKs](🔗) for guidance.

## ▶️ Initialize and Configure the SDK

Only use your public SDK key to configure Purchases

You can get your public SDK key from the **API keys** tab under **Project settings** in the dashboard.

You should only configure the shared instance of _Purchases_ once, usually on app launch. After that, the same instance is shared throughout your app by accessing the `.shared` instance in the SDK.

See our guide on [Configuring SDK](🔗) for more information and best practices.

Make sure you configure _Purchases_ with your public SDK key only. You can read more about the different API keys available in our [Authentication guide](🔗).

The `app_user_id` field in `.configure` is how RevenueCat identifies users of your app. You can provide a custom value here or omit it for us to generate an anonymous id. For more information, see our [Identifying Users](🔗) guide.

When in development, we recommend enabling more verbose debug logs. For more information about these logs, see our [Debugging](🔗) guide.

If you're planning to use RevenueCat alongside your existing purchase code, check out our guide on [Observer Mode](🔗).

Configuring Purchases with User IDs

If you have a user authentication system in your app, you can provide a user identifier at the time of configuration or at a later date with a call to `.logIn()`. To learn more, check out our guide on [Identifying Users](🔗).

## ▶️ Fetch and Display Available Products

The SDK will automatically fetch the [configured Offerings](🔗) and retrieve the product information from Apple, Google, or Amazon. Thus, available products will already be loaded when customers launch your purchase screen.

Below is an example of fetching Offerings. You can utilize Offerings to organize your paywall screen. See our guide on [Displaying Products](🔗) for more information and best practices.

### See it in action

(Script tags will be stripped)

If fetching your [Offerings](🔗), [products](🔗), or available [packages](🔗) are empty, it's due to some configuration issue in the respective store.

The most common reasons for this in App Store Connect are an out-of-date 'Paid Applications Agreement' or products not at least in the 'Ready To Submit' state. In Google Play this usually occurs when the app is not published on a closed track and a valid test user added.

You can find more info about troubleshooting this issue in our [Help Center](🔗).

## ▶️ Make a Purchase

The SDK includes a simple method for facilitating purchases. The `purchase:package` takes a package from the fetched Offering and processes the transaction with the respective app store.

The code sample below shows the process of purchasing a package and confirming it unlocks the "your_entitlement_id" content. More detail about the `purchase:package` method can be found in our guide on [Making Purchases](🔗).

### See it in action

(Script tags will be stripped)

💡 Here's a tip!

`purchase:package` handles the underlying framework interaction and automatically validates purchases with the respective store through our secure servers. This helps reduce in-app purchase fraud and decreases the complexity of your app. Receipt tokens are stored remotely and always kept up to date by RevenueCat.

## ▶️ Check Subscription Status

The SDK makes it easy to check what active subscriptions the current customer has, too. This can be done by checking a user's CustomerInfo object to see if a specific Entitlement is active, or by checking if the active Entitlements array contains a specific Entitlement ID.

If you're not using Entitlements (you probably should be!) you can check the array of active subscriptions to see what product IDs from the respective store it contains.

### See it in action

(Script tags will be stripped)

You can use this method whenever you need to get the latest status, and it's safe to call this repeatedly throughout the lifecycle of your app. _Purchases_ automatically caches the latest <<glossary:CustomerInfo>> whenever it updates — so in most cases, this method pulls from the cache and runs very fast.

It's typical to call this method when deciding which UI to show the user and whenever the user performs an action that requires a certain entitlement level.

💡 Here's a tip!

You can access a lot more information about a subscription than simply whether it's active or not. See our guide on [Subscription Status](🔗) to learn if subscription is set to renew, if there's an issue detected with the user's credit card, and more.

## ▶️ Restore Purchases

RevenueCat enables your users to restore their in-app purchases, reactivating any content that they previously purchased from the **same store account** (Apple, Google, or Amazon account). We recommend that all apps have some way for users to trigger the restore method. Note that Apple does require a restore mechanism in the event a user loses access to their purchases (e.g: uninstalling/reinstalling the app, losing their account information, etc).

### See it in action

(Script tags will be stripped)

If two different [App User IDs](🔗) restore transactions from the same underlying store account (Apple, Google, or Amazon account) RevenueCat may attempt to create an alias between the two App User IDs and count them as the same user going forward. See our guide on [Restoring Purchases](🔗) for more information on the different configurable restore behaviors.

## ▶️ Reacting to Subscription Status Changes

Since the SDK works seamlessly on any platform, changes to a user's purchase info may come from a variety of sources. You can respond to any changes in a customer's <<glossary:CustomerInfo>> by conforming to an optional delegate method, `purchases:receivedUpdated:`.

This method will fire whenever the SDK receives an updated CustomerInfo object from calls to `getCustomerInfo()`, `purchase(package:)`, `purchase(product:)`, or `restorePurchases()`.

<<glossary:CustomerInfo>> updates are _not_ pushed to your app from the RevenueCat backend, updates can only happen from an outbound network request to RevenueCat, as mentioned above.

Depending on your app, it may be sufficient to ignore the delegate and simply handle changes to customer information the next time your app is launched or in the completion blocks of the SDK methods.

### See it in action

(Script tags will be stripped)

You did it!

You have now implemented a fully-featured subscription purchasing system without spending a month writing server code. Congrats!

# Sample Apps

To download more complete examples of integrating the SDK, head over to our sample app resources.

**[View Samples ](🔗)**

# Next Steps

  • If you haven't already, make sure your products are configured correctly by checking out our [guide on entitlements ](🔗).

  • If you want to use your own user identifiers, read about [setting app user IDs ](🔗).

  • If you're moving to RevenueCat from another system, see our guide on [migrating your existing subscriptions ](🔗).

  • Once you're ready to test your integration, you can follow our guides on [testing and debugging ](🔗).

  • If you qualify for the App Store Small Business Program, check out our guide on [how to apply and inform RevenueCat ](🔗)