In app subscriptions

Verifies an Apple App Store or Google Play Store in-app purchase receipt and imports subscriptions for all historical purchases made by the customer.

CSV upload has a file size limitation that increases the processing time and the number of receipts. This API removes such limitations and allows you to import historical in-app subscription receipts.

Path Parameter

{in_app_subscription_app_id}: The handle created by Chargebee for your Apple App Store or Google Play Store app. It can be obtained from the Chargebee web app.

The following are instructions to obtain the value of the path parameter for the Apple App Store and Google Play Store.

• Apple App Store: To obtain the value for {in_app_subscription_app_id}, click View Keys within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.
• Google Play Store: To obtain the value for {in_app_subscription_app_id}, click Set up notifications within the Sync Overview page of the web app and use the value of generated App ID for this parameter. See detailed steps here.

# Import In app subscriptions for Apple App Store
curl  https://{site}.chargebee.com/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/import_receipt \
     -X POST  \
     -u {site_api_key}:\
     -d receipt="Apple Based64 Encoded Receipt" \
     -d product[currency_code]="USD" \
     -d customer[id]="customer-123" \
     -d customer[email]="customer@test.com"

# Import In app subscriptions for Apple App Store
curl  https://{site}.chargebee.com/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/import_receipt \
     -X POST  \
     -u {site_api_key}:\
     -d receipt="Apple Based64 Encoded Receipt" \
     -d product[currency_code]="USD" \
     -d customer[id]="customer-123" \
     -d customer[email]="customer@test.com"

Sample Response [ JSON ]

URL Format POST

The Import Subscriptions endpoint is a Chargebee API that allows you to import historic In-App Subscriptions without using a valid Apple App Store receipt. This endpoint is useful if you do not have access to the receipt data which is required for the Import Receipt API.

With this API, you can import subscriptions and corresponding invoices for historic In-App purchases. The API returns the in-app-subscriptions object once the historic subscription is successfully imported into Chargebee.

Apple App Store

This section provides details of the Import Subscription operation when performed for the Apple App Store. This API creates a historic subscription if the incoming subscription is unknown. For a known subscription, it creates an invoice for the mentioned period.

Chargebee validates the application ID with Apple App Store and does the following once validation succeeds:

Subscription

1. Import the subscription from the latest_receipt_info array from Apple and a new subscription is imported for the item-price. 
   Note: The subscription is not imported if it already exists in Chargebee but we will import the associated invoice using the subscription[transaction_id] in the payload. 

2. Each subscription imported has the following attribute set:

   • id set to subscription[id] . This subscription[id] is  original_transaction_id in the receipts.

   • start_date set to subscription[start_date]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms.

   • term_start set to subscription[term_start]. You need to provide this information from the oldest Latest_receipt_info.purchase_date_ms).

   • term_end set to subscription[term_end]. You need to provide this information from the oldest Latest_receipt_info.expires_date_ms.

   • item_price_id set to subscription[product_id] + subscription[currency_code]. You need to provide this information from the Latest_receipt_info.product_id.

   • Chargebee records the subscription in a Trial state if the is_trial_period is true.

   • Chargebee records the subscription in a Canceled state if the term_end is less than the System.currentTime().

Invoice for the subscription

1. The payment is recorded against the subscription invoice. 

   • Imported invoice has the subscription_id set to original_transaction_id.

Transactions for the invoice

1. The associated transaction is updated with the following details:

   • The transaction.reference_number is set to the transaction_id of the payment.

   • The transaction.payment_method is set to apple_store.  

# Imports an In app subscription for Apple App Store
curl  https://{site}.chargebee.com/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/import_subscription \
     -X POST  \
     -u {site_api_key}:\
     -d subscription[id]="460000725505054" \
     -d subscription[started_at]=1651363200 \
     -d subscription[term_start]=1651363200 \
     -d subscription[term_end]=1654041600 \
     -d subscription[product_id]="com.product.test" \
     -d subscription[currency_code]="USD" \
     -d subscription[transaction_id]="460000761293753" \
     -d subscription[is_trial]="false" \
     -d customer[id]="customer-123" \
     -d customer[email]="customer@test.com"

# Imports an In app subscription for Apple App Store
curl  https://{site}.chargebee.com/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/import_subscription \
     -X POST  \
     -u {site_api_key}:\
     -d subscription[id]="460000725505054" \
     -d subscription[started_at]=1651363200 \
     -d subscription[term_start]=1651363200 \
     -d subscription[term_end]=1654041600 \
     -d subscription[product_id]="com.product.test" \
     -d subscription[currency_code]="USD" \
     -d subscription[transaction_id]="460000761293753" \
     -d subscription[is_trial]="false" \
     -d customer[id]="customer-123" \
     -d customer[email]="customer@test.com"

# Retrieve subscription from the store using the receipt
curl  https://{site}.chargebee.com/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/retrieve \
     -X POST  \
     -u {site_api_key}:\
     -d receipt="Apple Based64 Encoded Receipt"

# Retrieve subscription from the store using the receipt
curl  https://{site}.chargebee.com/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/retrieve \
     -X POST  \
     -u {site_api_key}:\
     -d receipt="Apple Based64 Encoded Receipt"