This resource provides a unified representation of one-time order data across multiple sources , such as the Apple App Store and Google Play Store. It maps the underlying data one-to-one into Chargebee's omnichannel format. Functioning as a middleware , this solution ensures the data is delivered in a consistent, standardized format as presented.
Note: This resource specifically represents in-app product purchases made via the Apple App Store and Google Play Store.
Sample Omnichannel one time orderJSON
Omnichannel one time orders attributes
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
- For Apple, follow these steps.
- For Google, follow these steps.
The id
of the customer
object that is associated with this one time order.
The identifier of the one_time_purchase in the source.
For Apple App Store, it is the Transaction ID
of the initial_purchase_transaction.
For Google Play Store, it is the Order ID
of the initial_purchase_transaction
.
Country code indicating where the one-time order originated, such as US
for the United States.
The source
where the one-time order was originally made and managed.
The source of the app is apple_app_store
.
The source of the app is google_play_store
.
Indicates timestamp when the omnichannel_one_time_order
created in Chargebee.
Version number of this resource. The resource_version
is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
list of omnichannel_one_time_order_items in the omnichannel one time order
Omnichannel one time order item attributes
Identifier of the purchased item in the original source
(e.g., apple_app_store
or google_play_store
).
Indicates timestamp when this specific omnichannel_one_time_order_item
was cancelled
in the source
.
The reason of the omnichannel_one_time_order
cancellation for an item.
Indicates timestamp when the omnichannel_one_time_order_item
created in Chargebee.
Purchase transaction attributes
The identifier of the one time order in the source.
For Apple App Store, it is the Transaction ID
of the initial_purchase_transaction.
For Google Play Store, it is the Order ID
of the initial_purchase_transaction
.
App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
- For Apple, follow these steps.
- For Google, follow these steps.
The whole units of the amount.
For example:
if currencyCode is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1
if currencyCode is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123
if currencyCode is BHD (i.e. three decimal currency), then the unit value for BHD 1.234 will be 1
The fractional price amount, in nanos (billionths of the currency unit).
The value must be between 0 and +999,999,999 inclusive.
For example:
If currencyCode is USD (i.e. two decimal currency), then nanos value for USD 1.23 will be 230,000,000
If currencyCode is JPY (i.e. zero decimal currency), then nanos value for JPY 123 will be 0
If currencyCode is BHD (i.e. three decimal currency), then nanos value for BHD 1.234 will be 234,000,000
The type of transaction that occurred in the source
.
Indicates that the transaction occurred for a purchase.
Indicates that the transaction was initiated as part of a renewal for a previously completed purchase.
Timestamp when the transaction occurred in the source
.
Version number of this resource. The resource_version
is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
A list of omnichannel_subscription
objects linked to this transaction. Each entry represents a subscription associated with the transaction.