Events | Chargebee API documentation

API Version

Product Catalog

Library

All Events

Triggered when a tax withheld is refunded.

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

tax_withheld

object
The tax_withheld object affected by this event

invoice

object
The invoice object affected by this event

credit_note

object
The credit_note object affected by this event

Sample Payload

{
    "id": "ev_16BrhD9Tf4A3jJeH",
    "occurred_at": 1762406872,
    "source": "admin_console",
    "object": "event",
    "api_version": "v2",
    "event_type": "tax_withheld_refunded",
    "webhook_status": "not_applicable",
    "content": {
        "tax_withheld": {
            "id": "tax_withheld_example_id",
            "...": "..."
        },
        "invoice": {
            "adjustment_credit_notes": [],
            "amount_adjusted": 0,
            "amount_due": 0,
            "amount_paid": 1000,
            "amount_to_collect": 0,
            "...": "..."
        },
        "credit_note": {
            "allocations": [],
            "amount_allocated": 0,
            "amount_available": 500,
            "amount_refunded": 0,
            "base_currency_code": "USD",
            "...": "..."
        }
    }
}