credit_note.voided
Triggered when a credit note is voided while its invoice is still open. The invoice owes the amount again, and invoice.credit_notes_amount no longer counts the note.
X-Clocknext-Signature*stringt=<unix seconds>,v1=<hex HMAC-SHA256> — the HMAC of ${t}.${rawBody} keyed with the endpoint's signing secret. See Verify the signature.
X-Clocknext-Event-Id*stringThe event's id — the same as id in the body, and the same on every retry.
X-Clocknext-Event-Type*stringThe event name — the same as event_type in the body.
application/json- body
id*stringevt_ + 32 hex characters. Unique per event, and the same on every retry of it — use it to skip duplicates.
event_type*stringAlways credit_note.voided.
triggered_at*stringWhen the event was triggered (ISO 8601).
date-timedata*The customer, the voided credit note and its invoice.
Answer any 2xx within 5 seconds; the body is ignored. Anything else counts as failed and is retried.
{ "id": "evt_7d1c657dc3c2aec509c2719ba5908c9d", "event_type": "credit_note.voided", "triggered_at": "2026-11-16T10:05:00.000Z", "data": { "customer": { "id": "cus_9", "name": "Acme" }, "credit_note": { "id": "cn_1", "number": "CN-007", "status": "VOID", "destination": "REFUND_TO_CARD", "reason_code": "DUPLICATE_CHARGE", "reason": "Duplicate charge", "memo": null, "subtotal": 100, "tax_amount": 18, "amount": 118, "currency_code": "usd", "created_at": "2026-11-16T09:20:01.000Z", "voided_at": "2026-11-16T10:05:00.000Z" }, "invoice": { "id": "inv_42", "number": "INV-0042", "subscription_id": "pur_9", "amount": 118, "credit_notes_amount": 0 } }}{ "X-Clocknext-Signature": "t=1791367200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd", "X-Clocknext-Event-Id": "evt_7d1c657dc3c2aec509c2719ba5908c9d", "X-Clocknext-Event-Type": "credit_note.voided"}Types
Every object type on this page, with its fields.
CreditNoteVoidedEvent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | evt_ + 32 hex characters. Unique per event, and the same on every retry of it — use it to skip duplicates. |
event_type | string | yes | Always credit_note.voided. |
triggered_at | string | yes | When the event was triggered (ISO 8601). |
data | CreditNoteEventData | yes | The customer, the voided credit note and its invoice. |
CreditNoteEventData
The data object of a credit_note.created or credit_note.voided event: the customer, the credit note and its invoice, as they are after the change.
| Field | Type | Required | Description |
|---|---|---|---|
customer | WebhookCustomer | yes | The customer the event is about. |
credit_note | WebhookCreditNote | yes | The credit note when the event is triggered. |
invoice | WebhookCreditNoteInvoice | yes | The invoice the credit note lowers. |
WebhookCustomer
The customer the event is about.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The customer's Clocknext id. |
name | string | yes | The customer's name. |
WebhookCreditNote
A credit note: a document that lowers an invoice, in full or in part. All amounts are in USD. New values can be added to status, destination and reason_code.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The credit note's id. |
number | string | yes | The credit note's number. |
status | "ISSUED" | "VOID" | yes | ISSUED in credit_note.created, VOID in credit_note.voided. |
destination | "REDUCE_OPEN_INVOICE" | "CREDIT_TO_INVOICE_BALANCE" | "REFUND_TO_CARD" | yes | Where the amount goes: off the open invoice, to the invoice balance, or back to the card. |
reason_code | "DUPLICATE_CHARGE" | "FRAUDULENT_CHARGE" | "ORDER_CHANGED" | "PRODUCT_UNSATISFACTORY" | "PLAN_CHANGE_UNUSED_TIME" | "SUBSCRIPTION_CANCELLED_UNUSED_TIME" | yes | Why the credit note was made. The last 2 are the notes of a plan change and a cancel. |
reason | string | yes | The label of reason_code, for example Duplicate charge. |
memo | string | null | yes | The extra text. Null when no memo was given. |
subtotal | number | yes | The amount before tax, in USD. |
tax_amount | number | yes | The tax given back, in USD. 0 when the invoice has no tax. |
amount | number | yes | The total, in USD — subtotal plus tax_amount. |
currency_code | string | yes | Always usd — the amounts are in USD. |
created_at | string | yes | When the credit note was issued (ISO 8601). |
voided_at | string | null | yes | When the credit note was voided (ISO 8601). Null in credit_note.created. |
WebhookCreditNoteInvoice
The invoice of a credit note. When credit_notes_amount equals amount, the invoice is credited in full. That does not mean the money is on the card: for that, wait for refund.succeeded.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The invoice's id. |
number | string | yes | The invoice's number. |
subscription_id | string | null | yes | The subscription's purchase id. Null when the invoice belongs to no subscription. |
amount | number | yes | The invoice total in USD, tax included, as issued. A credit note never changes it. |
credit_notes_amount | number | yes | The total of the invoice's ISSUED credit notes, in USD, this one included. Void notes don't count. |
credit_note.created POST
Triggered when a credit note is issued on an invoice: by hand, through the API, by a cancel with a refund, or by a plan change. When `invoice.credit_notes_amount` equals `invoice.amount`, the invoice is credited in full.
refund.created POST
Triggered when a card refund is asked of the payment gateway, for a credit note or from the invoice balance. The money is not on the card yet: wait for `refund.succeeded`. A refund split over 2 card payments triggers 2 events.