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 order [ JSON ]
{
"id": "__test_oto_HmbXw88UrgaSKYa",
"app_id": "__test_gp_app_Hmdm904Upz2fet9",
"customer_id": "1mLtfx5Urfuna02JE",
"id_at_source": "bhggcokdffngjojmihfobjke",
"origin": "US",
"source": "google_play_store",
"created_at": 1753191402,
"resource_version": 1753191402443,
"object": "omnichannel_one_time_order",
"omnichannel_one_time_order_items": [
{
"id": "__test_otoi_HmbXw88UrgaSKab",
"item_id_at_source": "coin",
"quantity": 1,
"resource_version": 1753191402445,
"object": "omnichannel_one_time_order_item"
}
],
"purchase_transaction": {
"id": "__test_ot_HmbXw88UrgaSKGZ",
"id_at_source": "GPA.3346-4067-5254-30096",
"app_id": "__test_gp_app_Hmdm904Upz2fet9",
"price_currency": "USD",
"price_units": 5,
"price_nanos": 0,
"type": "purchase",
"transacted_at": 1753191346,
"created_at": 1753191402,
"resource_version": 1753191402000,
"object": "omnichannel_transaction"
}
}
API Index URL GET
https://{site}.chargebee.com/api/v2/omnichannel_one_time_orders
string, max chars=40 The ID generated by Chargebee for the recorded one-time order.
string, max chars=100 App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
optional, string, max chars=100 The id of the customer object that is associated with this one time order.
string, max chars=100 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.
optional, string, max chars=3 Country code indicating where the one-time order originated, such as US for the United States.
enumerated string The source where the one-time order was originally made and managed. Possible values are
apple_app_storeThe source of the app is apple_app_store.google_play_storeThe source of the app is google_play_store.
Show all values[+]
timestamp(UTC) in seconds Indicates timestamp when the omnichannel_one_time_order created in Chargebee.
optional, long 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. optional, list of omnichannel_one_time_order_item
list of omnichannel_one_time_order_items in the omnichannel one time order
Omnichannel one time order item attributes
string, max chars=40 Uniquely identifies a omnichannel_one_time_order_item
string, max chars=100 Identifier of the purchased item in the original source (e.g., apple_app_store or google_play_store).
optional, string, max chars=100 Product type in the source.
optional, integer The quantity of the omnichannel order item(s) purchased by the customer.
optional, timestamp(UTC) in seconds Indicates timestamp when this specific omnichannel_one_time_order_item was cancelled in the source.
optional, enumerated string The reason of the omnichannel_one_time_order cancellation for an item. Possible values are
customer_cancelledcustomer_did_not_consent_to_price_increaserefunded_due_to_app_issuerefunded_for_other_reason
Show all values[+]
timestamp(UTC) in seconds Indicates timestamp when the omnichannel_one_time_order_item created in Chargebee.
optional, long 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. optional, omnichannel_transaction
Details of the purchase transaction associated with the one-time order.
Purchase transaction attributes
string, max chars=40 Unique identifier for the omnichannel_transaction.
string, max chars=100 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.
string, max chars=100 App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
optional, string, max chars=3 The currency code for the transaction
optional, long 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
optional, long 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
enumerated string The type of transaction that occurred in the source. Possible values are
purchaseIndicates that the transaction occurred for a purchase.renewalIndicates that the transaction was initiated as part of a renewal for a previously completed purchase.
Show all values[+]
optional, timestamp(UTC) in seconds Timestamp when the transaction occurred in the source.
timestamp(UTC) in seconds Timestamp when the transaction was created.
optional, long 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.
linked_omnichannel_subscriptions [+] optional, list of linked_omnichannel_subscription
A list of omnichannel_subscription objects linked to this transaction. Each entry represents a subscription associated with the transaction.
Linked omnichannel subscription attributes
omnichannel_subscription_id
optional, string, max chars=100
linked_omnichannel_one_time_orders [+] optional, list of linked_omnichannel_one_time_order
A list of omnichannel_one_time_order objects linked to this transaction. Each entry represents a one-time order associated with the transaction.
Linked omnichannel one time order attributes
omnichannel_one_time_order_id
optional, string, max chars=100
This is a list of the event types we currently support. We will continue
to add more events moving forward. All events follow a uniform pattern -
<resource>_<event_name>. The resources that will be
present in the event content are provided beneath each event type's
description.
Note: If consolidated invoicing is enabled, the
attributes invoice.subscription_id and
credit_note.subscription_id should not be used
(as it will not be present if the invoice / credit note has lines from
multiple subscriptions). Instead to know the related subscriptions,
their line_items' subscription_id attribute should be referred.
string, max chars=40 The ID generated by Chargebee for the recorded one-time order.
string, max chars=100 App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
optional, string, max chars=100 The id of the customer object that is associated with this one time order.
string, max chars=100 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.
optional, string, max chars=3 Country code indicating where the one-time order originated, such as US for the United States.
enumerated string The source where the one-time order was originally made and managed. Possible values are
apple_app_storeThe source of the app is apple_app_store.google_play_storeThe source of the app is google_play_store.
Show all values[+]
timestamp(UTC) in seconds Indicates timestamp when the omnichannel_one_time_order created in Chargebee.
optional, long 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.
optional, list of omnichannel_one_time_order_item list of omnichannel_one_time_order_items in the omnichannel one time order
optional, omnichannel_transaction Details of the purchase transaction associated with the one-time order.
optional, long 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. optional, long
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.
Resource version attributes
timestamp(UTC) in seconds Indicates timestamp when the omnichannel_one_time_order_item created in Chargebee. required, timestamp(UTC) in seconds
Indicates timestamp when the omnichannel_one_time_order_item created in Chargebee.
optional, enumerated string The reason of the omnichannel_one_time_order cancellation for an item. Possible values are
customer_cancelledcustomer_did_not_consent_to_price_increaserefunded_due_to_app_issuerefunded_for_other_reason
Show all values[+] optional, enumerated string
The reason of the omnichannel_one_time_order cancellation for an item.
Cancellation reason attributes
optional, timestamp(UTC) in seconds Indicates timestamp when this specific omnichannel_one_time_order_item was cancelled in the source. optional, timestamp(UTC) in seconds Indicates timestamp when this specific omnichannel_one_time_order_item was cancelled in the source.
optional, integer The quantity of the omnichannel order item(s) purchased by the customer. optional, integer
The quantity of the omnichannel order item(s) purchased by the customer.
optional, string, max chars=100 Product type in the source. optional, string, max chars=100 Product type in the source.
Item type at source attributes
string, max chars=100 Identifier of the purchased item in the original source (e.g., apple_app_store or google_play_store). required, string, max chars=100
Identifier of the purchased item in the original source (e.g., apple_app_store or google_play_store).
Item id at source attributes
string, max chars=40 Uniquely identifies a omnichannel_one_time_order_item required, string, max chars=40
Uniquely identifies a omnichannel_one_time_order_item
optional, long 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. optional, long
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.
Resource version attributes
timestamp(UTC) in seconds Timestamp when the transaction was created. required, timestamp(UTC) in seconds
Timestamp when the transaction was created.
optional, timestamp(UTC) in seconds Timestamp when the transaction occurred in the source. optional, timestamp(UTC) in seconds
Timestamp when the transaction occurred in the source.
enumerated string The type of transaction that occurred in the source. Possible values are
purchaseIndicates that the transaction occurred for a purchase.renewalIndicates that the transaction was initiated as part of a renewal for a previously completed purchase.
Show all values[+] required, enumerated string
The type of transaction that occurred in the source.
optional, long 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
optional, long 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
optional, long 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
optional, long 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
optional, string, max chars=3 The currency code for the transaction optional, string, max chars=3
The currency code for the transaction
Price currency attributes
string, max chars=100 App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
required, string, max chars=100 App Identifier in Chargebee. This is the handle created by Chargebee for your app. To get the app_id:
string, max chars=100 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. required, string, max chars=100 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.
string, max chars=40 Unique identifier for the omnichannel_transaction. required, string, max chars=40
Unique identifier for the omnichannel_transaction.
linked_omnichannel_subscriptions
optional, list of linked_omnichannel_subscription A list of omnichannel_subscription objects linked to this transaction. Each entry represents a subscription associated with the transaction. optional, list of linked_omnichannel_subscription
A list of omnichannel_subscription objects linked to this transaction. Each entry represents a subscription associated with the transaction.
Linked omnichannel subscription attributes
omnichannel_subscription_id
optional, string, max chars=100 linked_omnichannel_one_time_orders
optional, list of linked_omnichannel_one_time_order A list of omnichannel_one_time_order objects linked to this transaction. Each entry represents a one-time order associated with the transaction. optional, list of linked_omnichannel_one_time_order
A list of omnichannel_one_time_order objects linked to this transaction. Each entry represents a one-time order associated with the transaction.
Linked omnichannel one time order attributes
omnichannel_one_time_order_id
optional, string, max chars=100 Retrieves an omnichannel_one_time_order object using its omnichannel_one_time_order_id. You can obtain the omnichannel_one_time_order_id for any successfully recorded purchase in Chargebee by using the List Omnichannel One-Time Orders API.
This API is not enabled for live sites by default. Please contact
support to get this enabled.
Sample Response [ JSON ]
Show more...
{
"omnichannel_one_time_order": {
"id": "__test_oto_HmbXw88UrgaSKYa",
"app_id": "__test_gp_app_Hmdm904Upz2fet9",
"customer_id": "1mLtfx5Urfuna02JE",
"id_at_source": "bhggcokdffngjojmihfobjke",
"origin": "US",
"source": "google_play_store",
"created_at": 1753191402,
"resource_version": 1753191402443,
"object": "omnichannel_one_time_order",
"omnichannel_one_time_order_items": [
{
"id": "__test_otoi_HmbXw88UrgaSKab",
"item_id_at_source": "coin",
"quantity": 1,
"resource_version": 1753191402445,
"object": "omnichannel_one_time_order_item"
},
{..}
],
"purchase_transaction": {
"id": "__test_ot_HmbXw88UrgaSKGZ",
"id_at_source": "GPA.3346-4067-5254-30096",
"app_id": "__test_gp_app_Hmdm904Upz2fet9",
"price_currency": "USD",
"price_units": 5,
"price_nanos": 0,
"type": "purchase",
"transacted_at": 1753191346,
"created_at": 1753191402,
"resource_version": 1753191402000,
"object": "omnichannel_transaction"
}
}
}
URL Format
GET
https://{site}.chargebee.com/api/v2/omnichannel_one_time_orders/{omnichannel-one-time-order-id}
always returned required
Resource object representing omnichannel_one_time_order
Sample admin console URL
https://{site}.chargebee.com/admin-console/omnichannel_one_time_orders/123x
Retrieves a list of omnichannel_one_time_orders objects.
This API is not enabled for live sites by default. Please contact
support to get this enabled.
Sample Response [ JSON ]
Show more...
{
"list": [
{
"omnichannel_one_time_order": {
"id": "__test_oto_HmbXw88UrgaSKYa",
"app_id": "__test_gp_app_Hmdm904Upz2fet9",
"customer_id": "1mLtfx5Urfuna02JE",
"id_at_source": "bhggcokdffngjojmihfobjke",
"origin": "US",
"source": "google_play_store",
"created_at": 1753191402,
"resource_version": 1753191402443,
"object": "omnichannel_one_time_order",
"omnichannel_one_time_order_items": [
{
"id": "__test_otoi_HmbXw88UrgaSKab",
"item_id_at_source": "coin",
"quantity": 1,
"resource_version": 1753191402445,
"object": "omnichannel_one_time_order_item"
},
{..}
],
"purchase_transaction": {
"id": "__test_ot_HmbXw88UrgaSKGZ",
"id_at_source": "GPA.3346-4067-5254-30096",
"app_id": "__test_gp_app_Hmdm904Upz2fet9",
"price_currency": "USD",
"price_units": 5,
"price_nanos": 0,
"type": "purchase",
"transacted_at": 1753191346,
"created_at": 1753191402,
"resource_version": 1753191402000,
"object": "omnichannel_transaction"
}
}
},
{..}
]
}
URL Format
GET
https://{site}.chargebee.com/api/v2/omnichannel_one_time_orders
optional, integer, default=10, min=1, max=100 The number of resources to be returned.
optional, string, max chars=1000 Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
optional, enumerated string filter
To filter based on OmnichannelOneTimeOrder Source. Possible values are : apple_app_store, google_play_store
Supported operators : is, is_not, in, not_in
Example → source[is] = "apple_app_store"
To filter based on OmnichannelOneTimeOrder Source.
pass parameters as source[<param name>][<operator>]
optional, enumerated string filter
Possible values are : apple_app_store, google_play_store
Supported operators :
Example →
optional, enumerated string filter
Possible values are : apple_app_store, google_play_store
Supported operators :
Example →
optional, string filter
Possible values are :
Supported operators :
Example →
optional, string filter
Possible values are :
Supported operators :
Example →
optional, string filter
Chargebee Customer External Identifier. Possible values are :
Supported operators : is, is_not, starts_with
Example → customer_id[is] = "8gsnbYfsMLds"
Chargebee Customer External Identifier.
pass parameters as customer_id[<param name>][<operator>]
customer_id[is][operator] customer_id[is][operator] optional, string, min chars=1 filter
Possible values are :
Supported operators :
Example →
customer_id[is_not][operator] customer_id[is_not][operator] optional, string, min chars=1 filter
Possible values are :
Supported operators :
Example →
customer_id[starts_with][operator] customer_id[starts_with][operator] optional, string, min chars=1 filter
Possible values are :
Supported operators :
Example →
always returned required
Resource object representing omnichannel_one_time_order
always returned optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
Sample admin console URL
https://{site}.chargebee.com/admin-console/omnichannel_one_time_orders/123x
Settings
Configure SDK
