A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"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>"
}
],
"has_more": true,
"next_cursor": "<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": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "PDF_RENDER_FAILED",
"message": "failed to render credit note PDF"
}
}List credit notes
A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"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>"
}
],
"has_more": true,
"next_cursor": "<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": "<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}$Query Parameters
Filter to credit notes for a specific invoice (inv_…).
Filter to credit notes for a specific customer (cus_…).
Filter by status.
issued, void Page size (default 20, max 100).
1 <= x <= 100Number of records to skip.
x >= 0Cursor: a credit note id (typically the previous response's next_cursor). Returns results strictly after it, newest first. Cannot be combined with offset.
Response
A paginated list of credit notes, newest first.
list The credit notes on this page.
Show child attributes
Show child attributes
True when more records exist beyond this page.
Present when has_more is true: the last returned credit note's id. Pass it as starting_after on the next request.

