get /v1/credit_notes

List all credit notes

GetCreditNotes

<p>Returns a list of credit notes.</p>

Parameters

Name In Type Required Description
created query object | integer no Only return credit notes that were created during the given date interval.
customer query string no Only return credit notes for the customer specified by this customer ID.
customer_account query string no Only return credit notes for the account representing the customer specified by this account ID.
ending_before query string no A 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 query string[] no Specifies which fields in the response should be expanded.
invoice query string no Only return credit notes for the invoice specified by this invoice ID.
limit query integer no A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after query string no A 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.

Request Body

application/x-www-form-urlencoded

Responses

200 Successful response.
default Error response.