Omnichannel statuses

API Version

Product Catalog

Library

An omnichannel subscription item represents a product or service an end user subscribes to across billing platforms such as Chargebee, the Apple App Store, or the Google Play Store.

Each platform uses its own statuses to indicate the state of a subscription. Chargebee’s Omnichannel Subscription Item status standardizes these statuses, offering a consistent set of states regardless of the underlying billing platform.

Omnichannel subscription item statuses

Currently, omnichannel subscription items have the following statuses:

Status	Description
`active`	A customer has an active subscription for an item.
`in_grace_period`	The subscription for an item has failed to renew due to a billing issue and is now in the grace period. Continue to provide service using the grace period while billing is retried.
`in_dunning`	The subscription for an item has failed to renew due to a billing issue and is now in the dunning period. Access to the subscription can be revoked while billing is retried. Inform the customer that their access is revoked and that there may be an issue with their billing information.
`cancelled`	A customer has canceled their subscription for an item either voluntarily or without consenting to the price increase for the subscription item. Check the cancellation reason to understand the reason for cancellation.
`expired`	An item's subscription has expired due to billing errors, the item being no longer available, or other reasons. Check the expiration reason to understand the reason for expiration.
`paused`	A customer has paused their subscription for an item.

Mapping of Apple subscription status to omnichannel subscription item status

The following table shows the mapping of Apple subscription status to omnichannel subscription item status:

Apple App Store Status	Omnichannel Subscription Item Status
`ACTIVE`	`active`
`BILLING_GRACE_PERIOD`	`in_grace_period`
`BILLING_RETRY`	`in_dunning`
`EXPIRED` with the expiration intents, `CUSTOMER_CANCELLED`, and `CUSTOMER_DID_NOT_CONSENT_TO_PRICE_INCREASE`	`cancelled`
`EXPIRED` with the expiration intents, `BILLING_ERROR`, `PRODUCT_NOT_AVAILABLE`, and `OTHER`	`expired`

Note:

To understand the possible subscription statuses in Apple, refer to the status documentation.
For more information on enabling grace period in Apple App Store, see Enable Billing Grace Period for auto-renewable subscriptions.
Apple App Store continues to retry billing for 60 days, or until the customer resolves their billing issue or cancels their subscription, whichever comes first. Learn more about reducing involuntary subscriber churn in Apple.
Additional statuses may be supported in the future with other billing system integrations.

Mapping of Google subscription status to omnichannel subscription item status

The following table shows the mapping of Google subscription status to omnichannel subscription item status:

Apple App Store Status	Omnichannel Subscription Item Status
`SUBSCRIPTION_STATE_ACTIVE`	`active`
`SUBSCRIPTION_STATE_CANCELED`	`active` Note: In this case, the `auto_renewal` flag is set to `false`, indicating that the omnichannel subscription is scheduled to be canceled at the end of the term.
`SUBSCRIPTION_STATE_EXPIRED` with the canceled state context as `userInitiatedCancellation`	`cancelled`