Credit notes are created automatically when a refund is processed. You can filter by
invoice to find all credit notes associated with a specific invoice.List credit notes
GET /v1/credit_notes
Returns a paginated list of credit notes, ordered by creation date descending.
Query parameters
string
Filter by invoice ID. Returns only credit notes issued against the specified invoice.
number
Maximum number of credit notes to return per page.
Response fields
object[]
required
Array of credit note objects.
boolean
required
Whether more credit notes exist beyond this page.
Retrieve a credit note
GET /v1/credit_notes/{id}
Retrieves the details of an existing credit note.
Path parameters
string
required
The ID of the credit note to retrieve.
Response fields
string
required
Unique credit note identifier.
string
required
ID of the invoice this credit note was issued against.
number
required
Amount credited.
string
required
Three-letter ISO 4217 currency code.
string
Reason for the credit note (e.g.
duplicate, fraudulent, order_change, product_unsatisfactory).string
required
Current status of the credit note.
string
required
ISO 8601 timestamp of when the credit note was created.