A valid request URL is required to generate request examples{
"id": "<string>",
"object": "credit_note",
"number": "<string>",
"invoice": "<string>",
"customer": "<string>",
"currency": "<string>",
"status": "issued",
"type": "post_payment",
"reason": "duplicate",
"subtotal": 123,
"tax": 123,
"total": 123,
"amount_refunded": 123,
"out_of_band_amount": 123,
"refund": "<string>",
"lines": [
{
"id": "<string>",
"object": "credit_note_line_item",
"type": "invoice_line_item",
"invoice_line_item": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"amount": 123,
"tax": 123,
"livemode": true
}
],
"memo": "<string>",
"livemode": true,
"created": 123,
"effective_at": 123,
"voided_at": 123,
"metadata": {},
"hosted_url": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "provide either lines or a single amount, not both"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "CREDIT_NOTE_NOT_FOUND",
"message": "credit note not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "PDF_RENDER_FAILED",
"message": "failed to render credit note PDF"
}
}Retrieve a credit note
A valid request URL is required to generate request examples{
"id": "<string>",
"object": "credit_note",
"number": "<string>",
"invoice": "<string>",
"customer": "<string>",
"currency": "<string>",
"status": "issued",
"type": "post_payment",
"reason": "duplicate",
"subtotal": 123,
"tax": 123,
"total": 123,
"amount_refunded": 123,
"out_of_band_amount": 123,
"refund": "<string>",
"lines": [
{
"id": "<string>",
"object": "credit_note_line_item",
"type": "invoice_line_item",
"invoice_line_item": "<string>",
"description": "<string>",
"quantity": 123,
"unit_amount": 123,
"amount": 123,
"tax": 123,
"livemode": true
}
],
"memo": "<string>",
"livemode": true,
"created": 123,
"effective_at": 123,
"voided_at": 123,
"metadata": {},
"hosted_url": "<string>"
}{
"error": {
"code": "INVALID_DATA",
"message": "provide either lines or a single amount, not both"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "CREDIT_NOTE_NOT_FOUND",
"message": "credit note not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "PDF_RENDER_FAILED",
"message": "failed to render credit note PDF"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.
^mer_[0-9A-Za-z]{14}$Path Parameters
The credit note id (cn_…).
Response
The 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.
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.
The credit lines on this note.
Show child attributes
Show child attributes
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.
Custom key-value pairs for your use.
Show child attributes
Show child attributes
Buyer-facing permalink for the hosted credit note view, when the hosted surface is enabled. Omitted otherwise.

