Skip to main content

In-App Purchase Key Configuration

When setting up a new App Store App on RevenueCat, you will need to add an in-app purchase key. This is a required configuration step. Previously, adding an in-app purchase key was not required; the requirement was added because the in-app purchase key allows RevenueCat to provide accurate information about the country, currency, and pricing for purchases, which previously had to be estimated in some cases. In addition, the in-app purchase key is required for features like Subscription offers or looking up customers by Order ID.

⚠️Adding an in-app purchase key may change historic data

Adding an in-app purchase key to an app with existing transactions may change historic data as we update previously estimated data with corrected data from Apple. As a result, you may see an increased number of updated transactions reported in your Scheduled Data Exports and your historical Charts data may also gradually update.

Setup​

1. Generating an In-App Purchase Key​

In-app purchase keys are generated App Store Connect under Users and Access → Integrations → In-App Purchase. You can use the same in-app purchase key for all App Store apps belonging to the same App Store Connect account.

Select Generate In-App Purchase Key, or—if you've generated an In-App Purchase Key in the past—click on the "+" symbol next to the Active header. You'll be prompted to enter a name for the key.

Once your key is generated, it will appear in Active Keys and you get one shot to download it.

Select Download API Key and store the file in a safe place, you'll need to upload this to RevenueCat in the next step.

2. Uploading the In-App Purchase Key to RevenueCat​

Once everything is set up in App Store Connect, you need to upload the In-App Purchase Key from the previous step to RevenueCat.

In the RevenueCat dashboard, select your App Store app from the Apps tab in your project settings.

Within your app settings, under the tab In-app purchase key configuration, you'll see an area to upload your In-App Purchase Key .p8 file that you downloaded from App Store Connect.

3. Providing the Issuer ID to RevenueCat​

Once you uploaded the in-app purchase .p8 file, you'll see an area to input 'Issuer ID'.

You can find this Issuer ID in App Store Connect, under Users and Access → Integrations → In-App Purchase.

If you haven't done so yet, you'll need to request access to the App Store Connect API. In that case, you will also need to generate a random App Store Connect API key. Access level or name of the key here doesn't matter, but the Issuer ID will not show unless a key has been generated.

Copy the Issuer ID, which is now shown at the top of the page, and paste into the RevenueCat 'Issuer ID' field.

Remember to select 'Save changes'.

Check the status of your credentials​

With our App Store credential validation, we will validate every time Apple credentials are (re)uploaded or at any time through a click of a button. A summary message will appear with the results of the validation to provide you additional information about the status of your App Store credentials.

Once your credentials are valid, you will see a "Valid credentials" message under your uploaded P8 key file with all permissions checked.

In-app purchase credential validator

Troubleshooting the credential validation​

Before starting to dive deeper in troubleshooting your credentials, you should confirm the following:

  • The P8 key file uploaded to RevenueCat is the correct file. You will be able to upload the file downloaded from App Store Connect directly into RevenueCat without changing the file name.
  • You have re-uploaded the credentials into RevenueCat

Invalid permissions​

If your permissions are invalid, you should double check the following:

  • The App Bundle ID is not missing and has correct capitalization
  • The issuer ID is correct
  • The in-app purchase key is active

Your in-app purchase key should be under 'Active' Active in-app purchase key

If it is not, it's most likely that your in-app purchase key has been revoked and you will need to follow the setup instructions in this documentation. Revoked in-app purchase key

Unable to select 'SAVE CHANGES'​

If the 'SAVE CHANGES' button is grayed out when trying to add your in-app purchase key, double check that you've filled out all the required fields in the RevenueCat app settings page. You can check this by expanding each section.