Omnichannel one time orders

API Version

Product Catalog

Library

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

https://{site}.chargebee.com/api/v2/omnichannel_one_time_orders

id

string, max chars=40
The ID generated by Chargebee for the recorded one-time order.

app_id

string, max chars=100

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.

customer_id

optional, string, max chars=100
The id of the customer object that is associated with this one time order.

id_at_source

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.

origin

optional, string, max chars=3
Country code indicating where the one-time order originated, such as US for the United States.

source

enumerated string
The source where the one-time order was originally made and managed.

Possible values are

created_at

timestamp(UTC) in seconds
Indicates timestamp when the omnichannel_one_time_order created in Chargebee.

resource_version

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.

omnichannel_one_time_order_items
Show attributes [+]

optional, list of omnichannel_one_time_order_item
list of omnichannel_one_time_order_items in the omnichannel one time order

purchase_transaction
Show attributes [+]

optional, omnichannel_transaction
Details of the purchase transaction associated with the one-time order.

Purchase transaction attributes

id

string, max chars=40
Unique identifier for the omnichannel_transaction.

id_at_source

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.

app_id

string, max chars=100

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.

price_currency

optional, string, max chars=3
The currency code for the transaction

price_units

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

price_nanos

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

type

enumerated string
The type of transaction that occurred in the source.

Possible values are

transacted_at

optional, timestamp(UTC) in seconds
Timestamp when the transaction occurred in the source.

created_at

timestamp(UTC) in seconds
Timestamp when the transaction was created.

resource_version

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

id

string, max chars=40
The ID generated by Chargebee for the recorded one-time order.

app_id

string, max chars=100

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.

customer_id

optional, string, max chars=100
The id of the customer object that is associated with this one time order.

id_at_source

origin

optional, string, max chars=3
Country code indicating where the one-time order originated, such as US for the United States.

source

enumerated string
The source where the one-time order was originally made and managed.

Possible values are

created_at

timestamp(UTC) in seconds
Indicates timestamp when the omnichannel_one_time_order created in Chargebee.

resource_version

omnichannel_one_time_order_items

optional, list of omnichannel_one_time_order_item
list of omnichannel_one_time_order_items in the omnichannel one time order

purchase_transaction

optional, omnichannel_transaction
Details of the purchase transaction associated with the one-time order.

resource_version

created_at

timestamp(UTC) in seconds
Indicates timestamp when the omnichannel_one_time_order_item created in Chargebee.

cancellation_reason

optional, enumerated string
The reason of the omnichannel_one_time_order cancellation for an item.

Possible values are

cancelled_at

optional, timestamp(UTC) in seconds
Indicates timestamp when this specific omnichannel_one_time_order_item was cancelled in the source.

quantity

optional, integer
The quantity of the omnichannel order item(s) purchased by the customer.

item_type_at_source

optional, string, max chars=100
Product type in the source.

item_id_at_source

string, max chars=100
Identifier of the purchased item in the original source (e.g., apple_app_store or google_play_store).

id

string, max chars=40
Uniquely identifies a omnichannel_one_time_order_item

resource_version

created_at

timestamp(UTC) in seconds
Timestamp when the transaction was created.

transacted_at

optional, timestamp(UTC) in seconds
Timestamp when the transaction occurred in the source.

type

enumerated string
The type of transaction that occurred in the source.

Possible values are

price_nanos

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

price_units

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

price_currency

optional, string, max chars=3
The currency code for the transaction

app_id

string, max chars=100

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.

id_at_source

id

string, max chars=40
Unique identifier for the omnichannel_transaction.

linked_omnichannel_subscriptions
Show attributes [+]

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_one_time_orders
Show attributes [+]

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.

Try in API Explorer

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.

Sample Request

Try in API Explorer

Only for Java

copy full code

Click to Copy

curl  https://{site}.chargebee.com/api/v2/omnichannel_one_time_orders/__test_oto_HmbXw88UrgaSKYa \
     -u {site_api_key}:

copy

Click to Copy

200:

STATUS

Sample Response [ JSON ]

{
    "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}

omnichannel_one_time_order

always returned
Resource object representing omnichannel_one_time_order

Try in API Explorer

Retrieves a list of omnichannel_one_time_orders objects.

Sample Request

Try in API Explorer

Only for Java

copy full code

Click to Copy

curl  https://{site}.chargebee.com/api/v2/omnichannel_one_time_orders \
     -G  \
     -u {site_api_key}:

copy

Click to Copy

200:

STATUS

Sample Response [ JSON ]

{
    "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

limit[]

optional, integer, default=10, min=1, max=100
The number of resources to be returned.

offset[]

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.

Filter Params

For operator usages, see the Pagination and Filtering section.

source[<operator>]

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"

customer_id[<operator>]

optional, string filter
Chargebee Customer External Identifier.
Supported operators : is, is_not, starts_with

Example → customer_id[is] = "8gsnbYfsMLds"

omnichannel_one_time_order

always returned
Resource object representing omnichannel_one_time_order

next_offset

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 omnichannel one time order [ JSON ]

API Index URL

Model Class

Omnichannel one time order attributes

Omnichannel One Time Order Item attributes

Purchase Transaction attributes

Consent Fields for Omnichannel one time order

Custom Fields for Omnichannel one time order

Retrieve an one time order one time order ¶

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

List Omnichannel one time orders ¶

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL