Getting Started

Product Catalog

Customers

Subscriptions

Invoices, Credit Notes, and Quotes

Taxes

Payments

Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics

Integrations

Import Products and In-app Receipts 

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:

  • Configure prerequisites including currency, product families, billing mode, and billing frequency.
  • Import In-App Purchase Products of your app as plans in Chargebee
  • Import In-App Purchase receipts to sync historical subscriptions into Chargebee

Configure Prerequisites 

As part of the integration you must confiugure prerequisites within your Chargebee site.

Currencies 

You must configure all of the currencies associated with your App Store app.
Click Configure to set up your currencies. Read more here.

Billing Mode 

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.

Product Catalog 

You must configure Product Families and set up billing frequencies for your Chargebee site. Read more about configuring product families here.

Billing Frequency 

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.

  1. Click Manage to view the Billing frequency options.

  2. Select the applicable options or click Add custom frequency to create billing frequencies.

  3. Enter the frequency, select the applicable duration and click Add.

  4. Click Apply to complete setting up your Billing Frequency.

Import Products 

You can choose to bulk import your product details including plan name, billing frequency, and price from your app.

Note

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:

  1. Click Product Import.

  2. Click Upload CSV.

  3. Prepare the bulk import file. Click Sample file and create entries for each product. Ensure the file is saved in csv format.

  4. Drag the updated file to the field or click Browse to upload the import file.

  5. Click Proceed after the successful upload of your bulk import file.

  6. After successful upload, the data within the bulk import file is validated and associated plans are created within your Chargebee site.

  7. Click Proceed to upload In-App Purchase Receipts.

Bulk Import Errors 

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

  1. Click Skip errors to skip products with errors.

  2. Click Yes, Proceed in the confirmation pop-up box to continue the upload process.

  3. Upon processing the information, the plans created and skipped displays.

  4. Click Proceed to upload In-App Purchase Receipts.

Fix Errors in Bulk Upload file

  1. Click Show errors to expand the list of errors.
  2. Click Download all errors if you wish to save the error log for future reference.
  3. Click Reupload CSV to access the bulk import file and make the corrections necessary from the error log.
  4. Review the Import Product document for assistance with uploading the import file.

Import In-App Purchase Receipts 

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.

Note

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:

  1. Click Upload In-App Purchase Receipts.

  2. Click Upload CSV.

  3. 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.

  4. Drag the updated file to the field or click Browse to upload the import file.

  5. Click Proceed after the successful upload of your bulk import file.

  6. After successful upload, the data within the bulk import file is validated and associated historical subscriptions are created within your Chargebee site.

Bulk Import Errors 

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:

Note

If you chose to Skip, all subscription data associated with the product will not be available within Chargebee.

Skip Records with Errors

  1. Click Skip errors to skip records with errors.
  2. Click Yes, Proceed in the confirmation pop-up box to continue the import process.
  3. After processing the in-app receipts, the subscription created and skipped displays.
  4. Click Proceed to review the Sync Overview and setup Notifications

Connection Keys 

After the import of Products and In-App Purchase receipts to your Chargebee site, you must configure the following connection keys:

  • Notification URL
  • Resource ID

Notification URL 

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

  1. Click View Keys in the Sync Overview page.

  2. Click Copy to copy the Notification URL to your clipboard.

  3. Login to your App Store Connect  account.

  4. Select applicable app from *My App.

  5. Click App Information from the General left menu.

  6. Enter the copied URL to the URL for App Store Server Notification field.

  7. Click Save.

Resource ID 

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.

  1. Click View Keys in the Sync Overview page.

  2. Click Copy to copy the resource ID to your clipboard.

Note

Click here  to view the API docs associated with Resource ID.

Was this article helpful?
Loading…