Credit notes
List credit notes
List credit notes, newest first.
GET/v1/credit_notes
Parameters
| Parameter | Description |
|---|---|
| invoice_idstring | null · queryoptional | No description in the spec. |
| customer_idstring | null · queryoptional | No description in the spec. |
| limitinteger · queryoptional | Defaults to 10. Between 1 and 100. |
| starting_afterstring | null · queryoptional | At most 128 characters. |
Cursor-paginated. limit caps a page and starting_after takes the last id you
saw.
Returns
Returns a page of CreditNoteResponse objects. data holds the page and has_more says whether another one exists. Page forward by passing the last id of the page as starting_after; a short page is not the end of the list.
Errors
| Status | Cause |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | Key is missing the credit_notes:read scope. |
| 422 | Validation Error |
| 429 | Rate limited. Back off and retry. |
Other credit notes operations
- Get credit note GET /v1/credit_notes/{credit_note_id}
- Get credit note PDF GET /v1/credit_notes/{credit_note_id}/pdf
BillKit