Subscription setup for iOS apps

In order for Adjust to communicate with Apple, you need to provide a set of credentials. In this article, learn how to:

1. Set up server notifications in your App Store Connect account. When you set up server notifications, the Apple App Store notifies Adjust of updates to your app's subscriptions. This lets Adjust trigger subscription events on time.
2. Generate an In-app Purchase key. The In-App Purchase key is required for all types of in-app purchases. Subscriptions are a type of in-app purchase.
3. Retrieve values from App Store Connect. These values are required to connect your App Store Connect account to Adjust.
   • Private key
   • Key ID
   • Issuer ID
4. Connect your App Store Connect credentials in Adjust.

Before you begin

Here's what you need to know before getting started.

Requirements​

• App in App Store Connect
• Admin permissions in App Store Connect
• Admin, Editor, or Custom Editor permissions in Adjust to connect your App Store Connect credentials in Adjust

Set up server notifications in App Store Connect

You need to set up server notifications in your App Store Connect account. When set up, the Apple App Store notifies Adjust of updates to your app's subscriptions.

1. Log in to your App Store Connect.
2. Select My Apps​.
3. Select the app you want to set up.
4. Select App Information​.
5. Under App Store Server Notifications > Production Server URL​, select Set Up URL​.
6. In the Production Server URL​ field, enter https://subscription.adjust.com/v2/appstore/.
   • Apple only supports one server notification URL. If you want to receive Apple subscription data to your servers first, then proxy the notifications to our endpoint: https://subscription.adjust.com/v2/appstore/.
7. Select Version 2 Notifications​.
   • Apple has deprecated Version 1 notifications. If you were on a previous version of subscriptions in Adjust, update to Version 2 Notifications.
8. Select Save​.

Log in to your App Store Connect account and select My Apps.

Select the app you want to set up.

Select App Information.

Under App Store Server Notifications > Production Server URL, select Set Up URL.

Enter https://subscription.adjust.com/v2/appstore/ and select Version 2 Notifications.

1/5

(1/5)

(2/5)

(3/5)

(4/5)

(5/5)

Generate an In-app Purchase key

We recommend that you generate an In-App Purchase key for Adjust in-app revenue verification. This key authorizes access to your app data from the App Store Server API. If you've not already requested API access in your App Store Connect account, complete the request before you create a key.

1. Log in to your App Store Connect.
2. Select Users and Access​.
3. Select Integrations​.
4. Under Key Type​, select In-App Purchase​.
5. Select the +​ icon to create an In-app Purchase key.
6. In the Name​ field, enter a name for the key.
7. Select Generate​.

Your In-app Purchase key appears in the list of active keys.

Select +.

Name the new key, then select Generate.

You can now see your new key in the active keys list.

1/3

(1/3)

(2/3)

(3/3)

Retrieve values from App Store Connect

1. Log in to your App Store Connect.
2. Select Users and Access​.
3. Select Integrations​.
4. Under Key Type​, select In-App Purchase​.
5. Next to Issuer ID​, select Copy​.
   • Example​: 57246542-96fe-1a63-e053-0824d011072a
6. For the key you generated, hover over the value in the Key ID column. Select Copy Key ID​ to copy the key ID.
   • Example:​ 2X9R4HXF34
7. For the same key, select Download In-App Purchase Key​, and then select Download​ to proceed.
8. Copy the entire private key from the downloaded .p8 file.
   • Example:​

-----BEGIN PRIVATE KEY-----
MIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgNxUqm0R2vt4IrLAQr9gfDPixwSxH9wJZ6NV3X0ax4eWgCgYIKoZIzj0DAQehasda2ANCAAQx53AlofI4Of54lbR04A6D2QMbe0mt8+JtRHkJJCEUesUfySoZsm2jeh3qodLE0pZ2Rayv26qFMKuKEwemB2Op
-----END PRIVATE KEY-----

Copy the Issuer ID

Copy the Key ID, and download the In-App Purchase key.

Confirm your intent to download the key.

1/3

(1/3)

(2/3)

(3/3)

Connect App Store Connect account in Adjust

You need to use the same App Store Connect account credentials in Adjust for all apps in your App Store Connect account. Follow these steps to add your App Store Connect credentials in Adjust.

1. Under DataWorks​, select Connections​.
2. Select + New Connection​.
3. Under Partner​, select App Store Connect (In-App Purchase)​.
4. Under Services​, select Subscription​.
5. Provide the values that you retrieved in the previous step.
   • Issuer ID​
   • Key ID​
   • Private key​
6. Select Connect​.

➡️ Next: Enable subscriptions for your app in Adjust​.