Omnichannel subscription item metrics

This resource represents the revenue metrics, such as MRR, computed for an Omnichannel subscription item.

This resource is available only with Product Catalog 2.0 and the Omnichannel Subscriptions feature. It is not available through any standalone API operation; it is returned only in the omnichannel_subscription_item_mrr_updated webhook event payload.

The event content includes the related omnichannel_subscription, omnichannel_subscription_item, and omnichannel_subscription_item_metric.

Omnichannel subscription item metrics attributes

customer_id

optional, string, max chars=100

The id of the customer object associated with this metric.

omnichannel_subscription_id

optional, string, max chars=100

The id of the omnichannel_subscription associated with this metric.

omnichannel_subscription_item_id

optional, string, max chars=100

The id of the omnichannel_subscription_item associated with this metric.

item_id_at_source

required, string, max chars=100

Product identifier of the subscription item in the source store.

Apple App Store: The App Store Connect product identifier.

Google Play Store: The Google Play product / base-plan identifier associated with the active entitlement.

mrr_currency

optional, string, max chars=3

The three-letter ISO 4217 currency code in which the MRR is calculated. May be absent when the MRR is unavailable.

mrr_units

optional, long

The whole-unit portion of the calculated MRR amount. Defaults to 0 when the MRR is zero or unavailable. For example: if mrr_currency is USD (i.e. two decimal currency), then the unit value for USD 1.23 will be 1 if mrr_currency is JPY (i.e. zero decimal currency), then the unit value for JPY 123 will be 123

mrr_nanos

optional, long

The fractional portion of the calculated MRR amount, in nanos (billionths of the currency unit). Defaults to 0 when the MRR is zero or unavailable. The value must be between 0 and +999,999,999 inclusive. For example: if mrr_currency is USD (i.e. two decimal currency), then the nanos value for USD 1.23 will be 230,000,000 if mrr_currency is JPY (i.e. zero decimal currency), then the nanos value for JPY 123 will be 0

effective_from

required, timestamp(UTC) in seconds

Timestamp from which this metric value is effective.

calculated_at

optional, timestamp(UTC) in seconds

The time at which Chargebee computed this metric value.

created_at

required, timestamp(UTC) in seconds

Indicates timestamp when the omnichannel_subscription_item_metric was created in Chargebee.

resource_version

optional, long

Version number of this immutable metric snapshot, as a timestamp in milliseconds. Each omnichannel_subscription_item_mrr_updated event delivers a new snapshot (for example after a renewal, price or offer change, or a status transition that affects revenue); earlier snapshots are not mutated.