Settings
API Version
Product Catalog
Library

Omnichannel subscription items

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 item [ JSON ]

{ "omnichannel_subscription_item_scheduled_change": { "omnichannel_subscription_item_id": "__test__osi_BXswds133lf1", "scheduled_at": 1739345778, "change_type": "downgrade", "object": "omnichannel_subscription_item_scheduled_change", "current_state": { "item_id_at_source": "com.example.landmarks.premium" }, "scheduled_state": { "item_id_at_source": "com.example.landmarks.basic" } } }

API Index URL GET

https://{site}.chargebee.com/api/v2/omnichannel_subscription_items

Model Class

 

      Omnichannel subscription item attributes
      
 
id
 

      string, max chars=40
 Uniquely identifies a omnichannel_subscription_item. 
 
 
item_id_at_source
 

      string, max chars=100
 Product ID in the source. 
 
 
item_parent_id_at_source
 

      optional, string, max chars=100
 The parent name of the product ID in the source. 
 
 
status
 

      enumerated string
 Status of the omnichannel_subscription_item. Learn more about status and their mapping with the store's status. 
 
Possible values are
 
 
activeWhen the subscription associated with the omnichannel_subscription_item is activeexpiredWhen the subscription associated with the omnichannel_subscription_item is expiredcancelledWhen the subscription associated with the omnichannel_subscription_item is cancelledin_dunningWhen the subscription associated with the omnichannel_subscription_item is in_dunning
 
 Show all values[+]
 
auto_renew_status
 

      optional, enumerated string
 The renewal status for the omnichannel_subscription_item. 
 
Possible values are
 
 
offThe auto-renewal of omnichannel_subscription_item is disabled.onThe auto-renewal of omnichannel_subscription_item is enabled.
 
 Show all values[+]
 
current_term_start
 

      optional, timestamp(UTC) in seconds
 Start of the current billing period of the subscription item. It is applicable only if the status is active. 
 
 
current_term_end
 

      optional, timestamp(UTC) in seconds
 End of the current billing period of the subscription item. It is applicable only if the status is active. 
 
 
expired_at
 

      optional, timestamp(UTC) in seconds
 Indicates timestamp when the subscription associated with the omnichannel_subscription_item was expired in the source 
 
 
expiration_reason
 

      optional, enumerated string
 Specifies the reason for the subscription expiration. 
 
Possible values are
 
 
billing_errorIndicates a billing error, such as the customer's payment information being invalid.product_not_availableIndicates that the product was unavailable for purchase at the time of renewal.otherIndicates that the subscription associated with the item expired for an unspecified reason.
 
 Show all values[+]
 
cancelled_at
 

      optional, timestamp(UTC) in seconds
 Indicates timestamp when the subscription associated with the omnichannel_subscription_item was cancelled in the source 
 
 
cancellation_reason
 

      optional, enumerated string
 The reason of canceling the subscription. 
 
Possible values are
 
 
customer_cancelledIndicates that the subscription was voluntarily cancelled by the customer.customer_did_not_consent_to_price_increaseIndicates that the customer did not consent to the price increase for the subscription item.refunded_due_to_app_issueIndicates that the subscription was cancelled and refunded due to the app issue.refunded_for_other_reasonIndicates that the subscription was cancelled and refunded for another reason.
 
 Show all values[+]
 
grace_period_expires_at
 

      optional, timestamp(UTC) in seconds
 Indicates timestamp when the grace period of subscription associated with the omnichannel_subscription_item expires in the source 
 
 
resumes_at
 

      optional, timestamp(UTC) in seconds
 Indicates timestamp when the subscription automatically resumes after being set to paused. 
 
 
has_scheduled_changes
 

      boolean, default=false
 Indicates whether the omnichannel_subscription_item has any scheduled changes. 
 
 
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. 
 
 
 

      upcoming_renewal
 Show attributes [+]
 
 optional, upcoming_renewal
 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.
 
 
 

      linked_item
 Show attributes [+]
 
 optional, linked_item
 Represents an active product catalog mapping between an omnichannel_subscription_item and a Chargebee item. Use this attribute to retrieve entitlements for the omnichannel_subscription_item that are associated with the linked Chargebee item.
 
 
 
 
id id
 

          string, max chars=40
 Uniquely identifies a omnichannel_subscription_item. 
 
item_id_at_source item_id_at_source
 

          string, max chars=100
 Product ID in the source. 
 
item_parent_id_at_source item_parent_id_at_source
 

          optional, string, max chars=100
 The parent name of the product ID in the source. 
 
status status
 

          enumerated string
 Status of the omnichannel_subscription_item. Learn more about status and their mapping with the store's status. 
 
Possible values are
 
 
activeWhen the subscription associated with the omnichannel_subscription_item is activeexpiredWhen the subscription associated with the omnichannel_subscription_item is expiredcancelledWhen the subscription associated with the omnichannel_subscription_item is cancelledin_dunningWhen the subscription associated with the omnichannel_subscription_item is in_dunning
 
 Show all values[+]
auto_renew_status auto_renew_status
 

          optional, enumerated string
 The renewal status for the omnichannel_subscription_item. 
 
Possible values are
 
 
offThe auto-renewal of omnichannel_subscription_item is disabled.onThe auto-renewal of omnichannel_subscription_item is enabled.
 
 Show all values[+]
current_term_start current_term_start
 

          optional, timestamp(UTC) in seconds
 Start of the current billing period of the subscription item. It is applicable only if the status is active. 
 
current_term_end current_term_end
 

          optional, timestamp(UTC) in seconds
 End of the current billing period of the subscription item. It is applicable only if the status is active. 
 
expired_at expired_at
 

          optional, timestamp(UTC) in seconds
 Indicates timestamp when the subscription associated with the omnichannel_subscription_item was expired in the source 
 
expiration_reason expiration_reason
 

          optional, enumerated string
 Specifies the reason for the subscription expiration. 
 
Possible values are
 
 
billing_errorIndicates a billing error, such as the customer's payment information being invalid.product_not_availableIndicates that the product was unavailable for purchase at the time of renewal.otherIndicates that the subscription associated with the item expired for an unspecified reason.
 
 Show all values[+]
cancelled_at cancelled_at
 

          optional, timestamp(UTC) in seconds
 Indicates timestamp when the subscription associated with the omnichannel_subscription_item was cancelled in the source 
 
cancellation_reason cancellation_reason
 

          optional, enumerated string
 The reason of canceling the subscription. 
 
Possible values are
 
 
customer_cancelledIndicates that the subscription was voluntarily cancelled by the customer.customer_did_not_consent_to_price_increaseIndicates that the customer did not consent to the price increase for the subscription item.refunded_due_to_app_issueIndicates that the subscription was cancelled and refunded due to the app issue.refunded_for_other_reasonIndicates that the subscription was cancelled and refunded for another reason.
 
 Show all values[+]
grace_period_expires_at grace_period_expires_at
 

          optional, timestamp(UTC) in seconds
 Indicates timestamp when the grace period of subscription associated with the omnichannel_subscription_item expires in the source 
 
resumes_at resumes_at
 

          optional, timestamp(UTC) in seconds
 Indicates timestamp when the subscription automatically resumes after being set to paused. 
 
has_scheduled_changes has_scheduled_changes
 

          boolean, default=false
 Indicates whether the omnichannel_subscription_item has any scheduled changes. 
 
resource_version 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. 
 
upcoming_renewal 
 

          optional, upcoming_renewal
 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. 
 
linked_item 
 

          optional, linked_item
 Represents an active product catalog mapping between an omnichannel_subscription_item and a Chargebee item. Use this attribute to retrieve entitlements for the omnichannel_subscription_item that are associated with the linked Chargebee item. 
 
 
 
Consent Fields for Omnichannel subscription item
 
 
Custom Fields for Omnichannel subscription item
 
  

      List scheduled changes for omnichannel subscription item
      
  
 
Returns a list of omnichannel_subscription_item_scheduled_change associated with the specified omnichannel_subscription_item.
  
Notes
 
 

        Sample Request
      
 

  Try in API Explorer

 
 
curl  https://{site}.chargebee.com/api/v2/omnichannel_subscription_items/{omnichannel-subscription-item-id}/scheduled_changes \
     -G  \
     -u {site_api_key}:
 

      copy
      
Click to Copy
 
 

    Sample Response [ JSON ]
 
Show more...
 
{
    "list": [
        {
            "omnichannel_subscription_item_scheduled_change": {
                "omnichannel_subscription_item_id": "__test__osi_BXswds133lf1",
                "scheduled_at": 1739345778,
                "change_type": "downgrade",
                "object": "omnichannel_subscription_item_scheduled_change",
                "current_state": {
                    "item_id_at_source": "com.example.landmarks.premium"
                },
                "scheduled_state": {
                    "item_id_at_source": "com.example.landmarks.basic"
                }
            }
        },
        {..}
    ]
}
 

      URL Format
      GET
 

      https://{site}.chargebee.com/api/v2/omnichannel_subscription_items/{omnichannel-subscription-item-id}/scheduled_changes
    
 
Method
 
 
Input Parameters
 
limit[]
 

      optional, integer, default=10, min=1, max=100 
 The number of resources to be returned. 
offset[]
 

      optional, string, max chars=1000 
 Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call. 
   
 
    
 
Returns
 
omnichannel_subscription_item_scheduled_change  omnichannel_subscription_item_scheduled_change
 

      always returned 
 Resource object representing omnichannel_subscription_item_scheduled_change
next_offset  next_offset
 
 optional, string, max chars=1000
 This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.
 
Sample admin console URL
 

      https://{site}.chargebee.com/admin-console/omnichannel_subscription_items/123x