This resource unifies representation of a Subscription item across multiple source.
Note: This resource represents in-app subscriptions made on Apple App Store and Google Play Store.
Sample Omnichannel subscription itemJSON
Omnichannel subscription items attributes
The parent name of the product ID in the source
.
Status of the omnichannel_subscription_item.
Learn more
about status and their mapping with the store's status.
When the subscription associated with the omnichannel_subscription_item
is active
When the subscription associated with the omnichannel_subscription_item
is expired
When the subscription associated with the omnichannel_subscription_item
is cancelled
When the subscription associated with the omnichannel_subscription_item
is in_dunning
When the subscription associated with the omnichannel_subscription_item
is in_grace_period
When the subscription associated with the omnichannel_subscription_item
is paused
The renewal status for the omnichannel_subscription_item
.
The auto-renewal of omnichannel_subscription_item
is disabled.
The auto-renewal of omnichannel_subscription_item
is enabled.
Start of the current billing period of the subscription item. It is applicable only if the status
is active
.
End of the current billing period of the subscription item. It is applicable only if the status
is active
.
Indicates timestamp when the subscription associated with the omnichannel_subscription_item
was expired
in the source
Specifies the reason for the subscription expiration.
Indicates a billing error, such as the customer's payment information being invalid.
Indicates that the product was unavailable for purchase at the time of renewal.
Indicates that the subscription associated with the item expired for an unspecified reason.
Indicates timestamp when the subscription associated with the omnichannel_subscription_item
was cancelled
in the source
The reason of canceling the subscription.
Indicates that the subscription was voluntarily cancelled by the customer.
Indicates that the customer did not consent to the price increase for the subscription item.
Indicates that the subscription was cancelled and refunded due to the app issue.
Indicates that the subscription was cancelled and refunded for another reason.
Indicates that the merchant revoked access to the subscription.
Indicates timestamp when the grace period of subscription associated with the omnichannel_subscription_item
expires in the source
Indicates timestamp when the subscription automatically resumes after being set to paused
.
Indicates whether the omnichannel_subscription_item
has any scheduled changes.
Version number of this resource. The resource_version
is updated with a new timestamp in milliseconds for every change made to the resource.
Represents the omnichannel_subscription_item_offers
associated with the omnichannel_subscription_item
.
This field contains information about the upcoming renewal. It is present only if the source
provides renewal information (currently available only for Google Play Store purchases) and the omnichannel_subscription_item
's auto_renew_status
is set to on
to renew for the next term. Otherwise, this field is absent.
Omnichannel subscription item offer attributes
Unique identifier for the omnichannel_subscription_item_offer.
System-generated.
Identifier of the offer on the source platform (for example, Apple App Store or Google Play Store). Used to map Chargebee's record to the source.
Indicates functional purpose of the offer. For example, introductory
indicates a first-time offer for new subscribers.
Introductory offer for first-time subscribers, typically providing special pricing or terms for the first billing cycle.
Promotional offer that may be available to both new and existing subscribers, often featuring limited-time pricing or terms.
Offer terms are determined by the developer and may include unique pricing or features. Note: Support for this category is planned for a future update.
Category label as defined by the source platform (for example, Apple App Store or Google Play Store). Directly fetched from the source; useful for debugging or platform-specific workflows.
Indicates how the offer is applied from a pricing-model perspective.
Provides a free trial period. The customer is not charged during the trial; regular billing begins after the trial ends.
Requires a fixed upfront payment for a defined subscription period, often at a discount. For example, pay for two months in advance.
Applies a recurring discounted price at each billing cycle over multiple renewals, such as on a monthly plan, a discount on the initial purchase, and the next three billing cycles.
Offer type as recorded by the source platform (for example, Apple App Store or Google Play Store), such as category_at_source is useful for tracking and audit.
Discount strategy: percentage discount, fixed amount off, or fixed price override.
Discount that subtracts a fixed amount from the original price of the subscription item.
Applies a percentage discount on the original price of the subscription item. For example, 20% off.
Overrides the original price with a fixed discounted price for the offer term. For example, set the price to $9.99 during the offer.
Indicates how long the offer applies to the subscription. This attribute uses ISO 8601 duration format. For example, P1M
(1 month), P7D
(7 days). After this duration, regular pricing resumes.
Used when discount_type
is percentage.
Specifies the discount as a decimal value. For example, a value of 12.5 corresponds to a 12.5% discount.
Three-letter ISO 4217 currency code for the offer price (for example, USD, EUR, INR).
Whole-unit portion of the offer amount (for example,10 for $10.00). Note: Depending on the discount type, this value can represent different meanings. For a fixed_amountdiscount, it indicates the amount deducted from the original price, while for a price discount, it reflects the final amount payable by the customer.
Fractional part of the offer amount, expressed in nanos (billionths of the currency unit). For example, 500000000represents 0.50. Combine withprice_units to determine the total price (for example, $10.50). Note: Depending on the discount type, this value can represent different meanings. For a fixed_amountdiscount, it indicates the amount deducted from the original price, while for a price discount, it reflects the final amount payable by the customer.
Timestamp when the offer becomes effective for the subscription item. It is typically set to the time when the offer is first applied or activated.
Timestamp when the offer becomes invalid. After this time, regular pricing or terms apply to the subscription item.