Events | Chargebee API documentation

API Version

Product Catalog

Library

All Events

Triggered when an omnichannel subscription item change is scheduled.

Event Schema

id

string
Unique identifier for the event

occurred_at

integer (unix timestamp)
Timestamp when the event occurred

source

string
Source that triggered the event (e.g., admin_console, api, scheduled_job)

object

string
Always "event" for webhook events

api_version

string
API version used for this event

event_type

string
Type of the webhook event

webhook_status

string
Status of the webhook delivery

content
Hide attributes [-]

object
Content of the event

omnichannel_subscription_item

object
The omnichannel_subscription_item object affected by this event

omnichannel_subscription_item_scheduled_change

object
The omnichannel_subscription_item_scheduled_change object affected by this event

customer

object
The customer object affected by this event

Sample Payload

{
    "id": "ev_16BX9WWeQKpCFJjl",
    "occurred_at": 1755864600,
    "source": "admin_console",
    "object": "event",
    "api_version": "v2",
    "event_type": "omnichannel_subscription_item_change_scheduled",
    "webhook_status": "not_applicable",
    "content": {
        "omnichannel_subscription_item": {
            "id": "omnichannel_subscription_item_example_id",
            "...": "..."
        },
        "omnichannel_subscription_item_scheduled_change": {
            "id": "omnichannel_subscription_item_scheduled_change_example_id",
            "...": "..."
        },
        "customer": {
            "allow_direct_debit": false,
            "auto_collection": "on",
            "billing_address": {
                "city": "Walnut",
                "country": "US",
                "first_name": "John",
                "last_name": "Doe",
                "line1": "PO Box 9999",
                "...": "..."
            },
            "card_status": "no_card",
            "created_at": 1517505731,
            "...": "..."
        }
    }
}