ChargebeeAPI

Process Purchase Command

Idempotency Supported
Try in API Explorer

Verifies an in-app purchase made by your customer and creates a subscription in Chargebee.

Note: If App Store or Play Store products have not been imported to Chargebee and this API is invoked, Chargebee will automatically create plans that correspond to the store product IDs. However, if historical subscriptions are to be imported using the import receipt API, importing products is mandatory. Learn more.

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.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/in_app_subscriptions/{in-app-subscription-app-id}/process_purchase_command

Input Parameters

receipt
required, string, max chars=65k

Apple App Store: The Base64 encoded App Store in-app purchase receipt taken from the Apple device after successful creation of the in-app purchase subscription. Google Play Store: The purchase token taken from the Android device after the successful creation of an in-app purchase subscription.

product
optional, string

Parameters for product

customer
optional, string

Parameters for customer

Returns

in_app_subscriptionIn app subscription object

Resource object representing in_app_subscription