Omnichannel transactions

API Version

Product Catalog

Library

A unified representation of Transaction across multiple source.

Apple App Store

The price value reflects the price you configured in App Store Connect, which the system records at the time of transaction (transacted_at) after the discount if any offers are applied.

Important For financial and accounting purposes, use the App Store Connect reporting tools. For more information, see Download financial reports and Overview of reporting tools. Learn more about price in Apple App Store.

Google Play Store

The Google Play Store does not provide the transaction amount or the purchase time. As a result, the system does not record the price value or time of the transaction(transacted_at).

Sample omnichannel transaction [ JSON ]

{
    "id": "__test__ot_LKedfs123ld1",
    "app_id": "__test__aas_sdfwerzx5134",
    "id_at_source": "20000006743",
    "price_currency": "USD",
    "price_units": 1,
    "price_nanos": 230000000,
    "type": "purchase",
    "created_at": 1517487053,
    "transacted_at": 1517487053,
    "object": "omnichannel_transaction"
}

id

string, max chars=40
The ID generated by Chargebee for the recorded purchase.

id_at_source

string, max chars=100
The id of the transaction in the 'source'. For Apple App Store, it is the 'Transaction ID' of the initial subscription 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 three-letter ISO 4217 currency code associated with 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 fraction part of the amount.

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
Omni-subscription transaction type that describes the transaction

Possible values are

transacted_at

optional, timestamp(UTC) in seconds
Timestamp denoting the time when the transaction occurred in Source

created_at

timestamp(UTC) in seconds
Omnichannel Transaction created time

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.

linked_omnichannel_subscriptions
Show attributes [+]

optional, list of linked_omnichannel_subscription

linked_omnichannel_one_time_orders
Show attributes [+]

optional, list of linked_omnichannel_one_time_order

id

string, max chars=40
The ID generated by Chargebee for the recorded purchase.

id_at_source

string, max chars=100
The id of the transaction in the 'source'. For Apple App Store, it is the 'Transaction ID' of the initial subscription 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 three-letter ISO 4217 currency code associated with 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 fraction part of the amount.

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
Omni-subscription transaction type that describes the transaction

Possible values are

transacted_at

optional, timestamp(UTC) in seconds
Timestamp denoting the time when the transaction occurred in Source

created_at

timestamp(UTC) in seconds
Omnichannel Transaction created time

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.

linked_omnichannel_subscriptions

optional, list of linked_omnichannel_subscription

linked_omnichannel_one_time_orders

optional, list of linked_omnichannel_one_time_order

Apple App Store

Google Play Store

Sample omnichannel transaction [ JSON ]

API Index URL

Model Class

Omnichannel transaction attributes

Consent Fields for Omnichannel transaction

Custom Fields for Omnichannel transaction