Using AI coding agents like Claude Code or Cursor? Try the official Chargebee Agent Skills to speed up your development.Try now
ChargebeeAPI

Omnichannel one time orders

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.

Sample Omnichannel one time orderJSON

API Index URL

https://[site].chargebee.com/api/v2/omnichannel_one_time_orders

Omnichannel one time orders attributes

id
required, string, max chars=40

The ID generated by Chargebee for the recorded one-time order.

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:

customer_id
optional, string, max chars=100

The id of the customer object that is associated with this one time order.

id_at_source
required, 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
required, enumerated string

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

Enum Values
apple_app_store

The source of the app is apple_app_store .

google_play_store

The source of the app is google_play_store .

created_at
required, 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

list of omnichannel_one_time_order_items in the omnichannel one time order

purchase_transaction

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

Omnichannel one time order item attributes

id
required, string, max chars=40

Uniquely identifies a omnichannel_one_time_order_item

item_id_at_source
required, string, max chars=100

Identifier of the purchased item in the original source (e.g., apple_app_store or google_play_store ).

item_type_at_source
optional, string, max chars=100

Product type in the source .

quantity
optional, integer

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

cancelled_at
optional, timestamp(UTC) in seconds

Indicates timestamp when this specific omnichannel_one_time_order_item was cancelled in the source .

cancellation_reason
optional, enumerated string

The reason of the omnichannel_one_time_order cancellation for an item.

Enum Values
customer_cancelled
customer_did_not_consent_to_price_increase
refunded_due_to_app_issue
refunded_for_other_reason
merchant_revoked
created_at
required, timestamp(UTC) in seconds

Indicates timestamp when the omnichannel_one_time_order_item 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.

Purchase transaction attributes

id
required, string, max chars=40

Unique identifier for the omnichannel_transaction .

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

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:

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
required, enumerated string

The type of transaction that occurred in the source .

Enum Values
purchase

Indicates that the transaction occurred for a purchase.

renewal

Indicates that the transaction was initiated as part of a renewal for a previously completed purchase.

transacted_at
optional, timestamp(UTC) in seconds

Timestamp when the transaction occurred in the source .

created_at
required, timestamp(UTC) in seconds

Timestamp when the transaction was created.

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.

linked_omnichannel_subscriptions

A list of omnichannel_subscription objects linked to this transaction. Each entry represents a subscription associated with the transaction.

linked_omnichannel_one_time_orders

A list of omnichannel_one_time_order objects linked to this transaction. Each entry represents a one-time order associated with the transaction.