List all credit notes

GET {{baseUrl}}/v1/credit_notes

Returns a list of credit notes.

Request Params

KeyDatatypeRequiredDescription
customerstringOnly return credit notes for the customer specified by this customer ID.
ending_beforestringA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
expand[0]stringSpecifies which fields in the response should be expanded.
expand[1]stringSpecifies which fields in the response should be expanded.
invoicestringOnly return credit notes for the invoice specified by this invoice ID.
limitstringA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterstringA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring