Events | Chargebee API documentation

API Version

Product Catalog

Library

Triggered when the subscription is cancelled. If it is cancelled due to non payment or because the card details are not present, the subscription will have the possible reason as 'cancel_reason'.

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

subscription

object
The subscription object affected by this event

customer

object
The customer object affected by this event

card

object
The card object affected by this event

invoice

object
The invoice object affected by this event

credit_notes

object
The credit_notes object affected by this event

unbilled_charges

object
The unbilled_charges object affected by this event

Sample Payload

{
    "id": "ev_16BSYinK2bebavxt",
    "occurred_at": 1762406872,
    "source": "admin_console",
    "object": "event",
    "api_version": "v2",
    "event_type": "subscription_cancelled",
    "webhook_status": "not_applicable",
    "content": {
        "subscription": {
            "activated_at": 1612890938,
            "billing_period": 1,
            "billing_period_unit": "month",
            "created_at": 1612890938,
            "currency_code": "USD",
            "...": "..."
        },
        "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,
            "...": "..."
        },
        "card": {
            "card_type": "american_express",
            "created_at": 1517486946,
            "customer_id": "__test__XpbTXGTSRp3ELNCY",
            "expiry_month": 12,
            "expiry_year": 2022,
            "...": "..."
        },
        "invoice": {
            "adjustment_credit_notes": [],
            "amount_adjusted": 0,
            "amount_due": 0,
            "amount_paid": 1000,
            "amount_to_collect": 0,
            "...": "..."
        },
        "credit_notes": {
            "id": "credit_notes_example_id",
            "...": "..."
        },
        "unbilled_charges": {
            "id": "unbilled_charges_example_id",
            "...": "..."
        }
    }
}