Skip to main content
GET
List Invoices

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

expand
string
default:""

Comma-separated list of related objects to expand in the response.

Example:

""

customer
string | null

Filter invoices by customer ID

Example:

"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

starting_after
string | null

A cursor for use in pagination. starting_after is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 20 invoices, ending with fin_xyz, your subsequent call can include starting_after=fin_xyz to fetch the next page.

Example:

"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

A cursor for use in pagination. ending_before is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 20 invoices, starting with fin_abc, your subsequent call can include ending_before=fin_abc to fetch the previous page.

Example:

"fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Required range: 1 <= x <= 100
Example:

10

Response

An envelope wrapping a list of invoice objects.

An envelope wrapping a list of invoice objects.

invoices
object[]
required

The list of invoices.