Void a credit note
Voids an issued credit note, marking it void and stamping voided_at.
A credit note already in void status returns 422. Send an
Idempotency-Key header so a retried request replays the original void
rather than rejecting a second attempt.
Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Required. A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.
255Path Parameters
The credit note id (cn_…).
Response
The voided credit note.
Credit note id (cn_…).
credit_note The gapless per-merchant number assigned at creation (for example CN-000001).
The invoice this credit note offsets (inv_…).
The customer the invoice was issued to (cus_…).
Three-letter ISO currency code.
issued is the normal state after creation; void means the credit note has been reversed.
issued, void Always post_payment in v1.
post_payment The reason given at creation, or null if none was provided.
duplicate, fraudulent, order_change, product_unsatisfactory, adjustment Sum of line amounts before tax, in minor units.
Total tax credited, in minor units.
Total credit amount (subtotal + tax), in minor units.
Portion returned via the linked refund, in minor units.
Portion settled outside the platform, in minor units.
The linked refund (rf_…), or null when settlement was out-of-band only.
Free-text note printed on the PDF, or null if none was provided.
Unix epoch seconds.
Unix epoch seconds the credit is dated to.
Unix epoch seconds when the note was voided, or null while still issued.
Buyer-facing permalink for the hosted credit note view, when the hosted surface is enabled. Omitted otherwise.

