Skip to main content
GET
List credit notes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
string<MeteroidId>

Filter by customer ID

Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

invoice_id
string<MeteroidId>

Filter by invoice ID

Example:

"inv_7n42DGM5Tflk9n8mt7Fhc7"

status
enum<string>
Available options:
DRAFT,
FINALIZED,
VOIDED

Free-text search over credit note number.

order_by
string

Sort order. Format: column.direction. Allowed columns: created_at, credit_note_number, total, status. Direction: asc or desc. Default: created_at.desc.

page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of credit notes

data
object[]
required
pagination_meta
object
required