Your Apple Store app is now connected to Chargebee. This document guides you through the process of configuring prerequisite settings and import of historical data from the App Store. During this process you will complete the following steps:
As part of the integration you must confiugure prerequisites within your Chargebee site.
You must configure all of the currencies associated with your App Store app.
Click Configure to set up your currencies. Read more here.
You must model the accountable duration for your billing to include milli-second based billing and enable proration for your app in Chargebee.
Click Configure to set up your Billing mode. Read more here.
You must configure Product Families and set up billing frequencies for your Chargebee site. Read more about configuring product families here.
You must configure the billing frequency options associated with your product catalog when creating Plans, Addons, or Charges. The pre-configured options include Daily, Weekly, Monthly, and Yearly. However, you can also create custom billing frequencies.
Click Manage to view the Billing frequency options.
Select the applicable options or click Add custom frequency to create billing frequencies.
Enter the frequency, select the applicable duration and click Add.
Click Apply to complete setting up your Billing Frequency.
You can choose to bulk import your product details including plan name, billing frequency, and price from your app.
Click Proceed, if you have no historical product data or would like to skip importing the information.
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.
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 In-App Purchase Receipts.
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.
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.
Upon processing the information, the plans created and skipped displays.
Click Proceed to upload In-App Purchase Receipts.
Fix Errors in Bulk Upload 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.
Click Proceed if you do not wish to import historical subscriptions or have no in-app purchases yet.
Follow the steps below to import your In-App Purchase Receipts to Chargebee:
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
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.
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 App.
Click App Information from the General left menu.
Enter the copied URL to the URL for App Store Server Notification field.
Click Save.
The Resource ID is a unique identifier created for your Apple app within Chargebee. This identifer is configured in 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 resource ID to your clipboard.
Click here to view the API docs associated with Resource ID.