Docs
Your Apple Store app is now connected to Chargebee. This document guides you through the process of configuring connection keys generated by Chargebee in App Store connect, import of products and upload receipts from the App Store. During this process you will complete the following steps:
After the import of Products and In-App Purchase receipts to your Chargebee site, you must configure the following connection keys:
Your Chargebee site must be updated with the most recent changes associated with subscriptions on App Store. This can be accomplished with the use of Notification URLs wherein App Store sends notifications to your server of real-time changes in a subscription's status.
Enable v1 notifications in the Apple App Store for subscriptions created without receipts. Chargebee depends on receipt data to update subscription statuses. Apple's v2 notifications do not have receipt information; therefore, Chargebee cannot process v2 notifications for subscriptions imported without receipts. Learn more about app store notifications.
Follow the steps below to configure the Notification URL
Click View Keys in the Sync Overview page.
Click Copy to copy the Notification URL to your clipboard.
Login to your App Store Connect account.
Select applicable app from My Apps.
Click App Information from the General left menu.
Navigate to the App Store Server Notifications section.
Click Setup URL in the Production Server URL/Sandbox Server URL as applicable.
Enter the copied URL to the Server URL field.
Select Version 1 Notifications or Version 2 Notifications radio button as required.
Click Save.
The App ID is a unique identifier created for your Apple app within Chargebee. This identifer is configured within the backend server of your app to create unique API endpoints, which can be used extensively for completing API actions.
Follow the steps below to retrieve this information.
Click View Keys in the Sync Overview page.
Click Copy to copy the App ID to your clipboard.
Click here to view the API docs associated with App ID.
You can choose to bulk import your product details including plan name, billing frequency, and price from your app.
Follow the steps below to import your product details to Chargebee:
Click Product Import.
Click Upload CSV.
Prepare the bulk import file. Click Sample file and create entries for each product. Ensure the file is saved in csv format.
Note: When entering prices in the CSV file, use cents as the unit. For example, enter 3900 in the price column for USD 39.
Drag the updated file to the field or click Browse to upload the import file.
Click Proceed after the successful upload of your bulk import file.
After successful upload, the data within the bulk import file is validated and associated plans are created within your Chargebee site.
Click Proceed to upload your product offerings to Chargebee.
Any errors identified during the data validation process will result in the plan associated with that product information not being created. Such errors can be attributed to various reasons such as incorrect currency, frequency, or product ID.
Failure to adhere to these guidelines will result in errors while creating plans.
The data validation functionality assists in identifying the errors allowing you to resolve them more effectively or skipping the upload of products with errors. Determine your course of action based on the options below:
Skip Products with Errors
Click Skip errors to skip products with errors.
Click Yes, Proceed in the confirmation pop-up box to continue the upload process.
Click Yes, Proceed to upload In-App Purchase Receipts.
Fix Errors in Bulk Upload file
Click Show errors to expand the list of errors.
Click Download all errors if you wish to save the error log for future reference.
Click Reupload CSV to access the bulk import file and make the corrections necessary from the error log.
Review the Import Product document for assistance with uploading the import file.
You can choose to import your historical subscriptions associated IAP for the product offerings available on your app using this functionality. Addtionally, if you choose to use API's, only the latest transaction of the in-app receipts will be processed.
The following guidelines apply to In-App Receipts:
Follow the steps below to import your In-App Purchase Receipts to Chargebee:
Ensure that all your Apple products are uploaded to Chargebee previously.
Click Upload In-App Purchase Receipts.
Click Upload CSV.
Prepare the bulk import file. Click Sample file and create entries for each of the historical subscriptions. Ensure that the file is saved in CSV format after your changes are made.
Drag the updated file to the field or click Browse to upload the import file.
Click Proceed after the successful upload of your bulk import file.
After successful upload, the data within the bulk import file is validated and associated historical subscriptions are created within your Chargebee site.
Any errors identified during the data validation process will result in the historical subscriptions associated with that product information not being created. Such errors can be attributed to various reasons such as incorrect currency, frequency, or product ID.
The data validation functionality assists in identifying the errors allowing you to resolve them more effectively or skipping the upload of products with errors. Determine your course of action based on the options below:
If you chose to Skip, all subscription data associated with the product will not be available within Chargebee.
Skip Records with Errors
The Sync Overview acts as the landing page for your integration with App Store. This view lists all of the subscriptions details including status of the subscription and sync statistics for the last 24 hours.
API References
Articles & FAQ