Apple In-App Purchases with Conscent

This guide helps you integrate Apple In-App Purchases (IAP) with the Conscent Gateway.

It covers creating subscriptions in the App Store, retrieving credentials, configuring the Conscent Gateway, and setting up subscription plans. Follow these steps to go live with IAP smoothly.

Prerequisites

• An Apple Developer account with administrative access to App Store Connect.

• Your app is registered in App Store Connect with a unique Bundle ID.

• The latest Paid Applications Agreement is signed in the "Agreements, Tax, and Banking" section of App Store Connect.

• All required tax and banking information is fully completed in App Store Connect.

Step 1: Retrieve App Information from App Store Connect

1.1 Access App Store Connect

• Navigate to App Store Connect.

• Sign in with your Apple Developer credentials.

1.2 Retrieve the Bundle ID and App Name

• From the dashboard, click on “My Apps”.

• Select the app for which you want to configure In-App Purchases.

• To locate the Bundle ID:

  • In the sidebar, click on “App Information”.

  • Under “General Information”, find the Bundle ID.

• Note down both the App Name and the Bundle ID for future reference.

Step 2: Obtain App Store Connect API Key and AuthKey File

2.1 Access Users and Access Section

• In App Store Connect, click on “Users and Access” from the dashboard.

2.2 Create a User with API Access

• Click on the ”+” icon to add a new user or select an existing one.

• Assign the user the “Admin” or “App Manager” role.

• Ensure the user has API Access enabled.

2.3 Generate API Key for the User

• Navigate to the “Keys” tab within “Users and Access”.

• Click on “Generate API Key”.

• Enter a name for the key and select “Admin” for access level.

• Click “Generate”.

• Download the AuthKey_<KeyID>.p8 file and store it securely.

• Note down the following:

  • Key ID: Available in the “Keys” section.

  • Issuer ID: Found at the top of the “Keys” page.

• Click on “Shared Secret” and note it down as well.

Step 3: Configure the Conscent Gateway

3.1 Access Conscent Gateway Configuration

• Log in to your Conscent dashboard.

• Navigate to the “Monetize” section.

• Click on “Payment Gateway” and select “In-App Purchase Apple”.

3.2 Input App and Key Details

• Enter the App Name and Bundle ID obtained earlier.

• Upload the AuthKey.p8 file.

• Enter the Key ID, Shared Secret Key, and Issuer ID in their respective fields.

3.3 Save Configuration

• Review all the entered information for accuracy.

• Click on “Save Changes” to finalize the gateway configuration.

Step 4: Create In-App Purchase Products in App Store Connect

4.1 Create a Subscription Group

• In App Store Connect, select your app from “My Apps”.

• In the sidebar under “Monetization”, click on “Subscriptions”.

• If “Subscriptions” is not visible, ensure all agreements in “Agreements, Tax, and Banking” are accepted.

• Click on “Create” to add a new Subscription Group.

• Enter a Reference Name for internal use (e.g., “Premium Access Subscriptions”).

• Click “Create”.

4.2 Add a Subscription Product

• Within the Subscription Group, click on “Create” to add a new subscription.

• Enter the following:

  • Reference Name: Internal name for the subscription (e.g., “Premium Annual Subscription”).

  • Product ID: A unique identifier (e.g., “com.yourapp.premium.annual”).

  • Recommendation: Use a consistent naming convention.

  • Click “Create”.

4.3 Set Subscription Duration and Price

• Under “Subscription Duration”, select the appropriate duration (e.g., “1 Year”).

• Click “Save”.

• In the “Subscription Prices” section, click “Add Subscription Price”.

• Choose a price tier from the dropdown menu.

• Click “Next” and confirm the prices for all regions.

• Click “Save”.

4.4 Add Localization Information

• In the “App Store Information” section, click on the ”+” icon next to “Localization”.

• Select the desired language (e.g., “English (U.S.)”).

• Enter the following:

  • Subscription Display Name: Visible to users (e.g., “Premium Annual Access”).

  • Description: Detail what the subscription offers.

  • Click “Save”.

4.5 Add Reviewer Information

• In the “Review Information” section, upload a screenshot of your subscription purchase screen.

• Note: The screenshot must meet Apple’s requirements.

• Optionally, add Review Notes to provide additional information to the reviewer.

• Click “Save”.

Step 5: Configure Subscription Plans in Conscent Dashboard

5.1 Access Subscription Plans

• In the Conscent Dashboard, navigate to the “Subscriptions” section.

• Click on “Create Subscription Plan”.

5.2 Choose Subscription Type

• Select “In-App” as the subscription type.

• Choose between “Recurring Subscription” or “One-Time Subscription” based on your product.

5.3 Configure Recurring Subscriptions

• Subscription Group Name: Enter the name of the Subscription Group created in App Store Connect.

• Apple Product ID: Enter the Product ID of the subscription.

• Duration: Specify the subscription duration (e.g., “1 Year”).

5.4 Configure Non-Renewing Subscriptions

• Apple Product ID: Enter the Product ID of the non-renewing subscription.

• Duration: Specify the access duration (e.g., “6 Months”).

• Price: Leave blank; pricing will be determined by the price tier set in App Store Connect.

5.5 Save Subscription Plan

• Provide the other parameters and review the entered details.

• Click “Save” to create the subscription plan.

Step 6: Provide Starting Price CSV to Conscent

6.1 Download Pricing CSV from App Store Connect

• In App Store Connect, navigate to your subscription product.

• Under “Subscription Prices”, click on “Download”.

• A .zip file containing the .csv pricing information will be downloaded.

6.2 Provide Pricing CSV to Conscent

• Extract the .csv file from the downloaded .zip.

• Upload the .csv file to the Conscent Dashboard or provide it to your Conscent representative.

• This allows Conscent to synchronize pricing across different regions.

INFORMATION THAT NEED TO SHARED WITH CONSCENT

• App Name

• Bundle ID

• KeyId

• AuthKey.p8 file

• Issuer Id

• One-Time Subscription Plan- ProductId + Duration

• Renewal Subscription Plan - Group Name + productId + Duration

• CSV file of both the plans(StartingPrice and CurrentPrice)

Integrating App Store Server Notifications:

We use App Store Server Notifications to track in-app purchase events in real time. By registering our web server’s HTTPS endpoint in App Store Connect, we receive direct notifications for subscription updates, renewals, and cancellations. Separate URLs are configured for production and sandbox environments, ensuring seamless testing and a reliable purchase experience.

Conclusion

Your app is now ready to offer In-App Purchases to users, providing them with seamless access to your premium content. Should you require further assistance, please refer to Apple’s official documentation or contact Conscent team.

Additional Resources

• Apple’s App Store Connect Help

• In-App Purchase Programming Guide

Note: Always ensure compliance with Apple’s guidelines and review policies when setting up In-App Purchases to avoid any delays during the app review process.

Add the Conscent webhook URL to the Apple account.