Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Query Parameters

invoice
string

Filter to credit notes for a specific invoice (inv_…).

customer
string

Filter to credit notes for a specific customer (cus_…).

status
enum<string>

Filter by status.

Available options:
issued,
void
limit
integer
default:20

Page size (default 20, max 100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip.

Required range: x >= 0
starting_after
string

Cursor: 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.

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required

True when more records exist beyond this page.

next_cursor
string

Present when has_more is true: the last returned credit note's id. Pass it as starting_after on the next request.