Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only

Query Parameters

limit
integer
default:20

How many to return, 1 to 100.

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

20

starting_after
string

The id of the last invoice of the previous page; the page after it is returned.

Required string length: 1 - 64
Example:

"019e2b4c-7a1d-7c3e-9f20-5b8d4e6a1c31"

number
string

Only invoices with this number. Usually one; a number can repeat across customers.

Required string length: 1 - 100
Example:

"INV-1042"

external_id
string

Only the invoice your ERP knows by this id: at most one.

Required string length: 1 - 100
Example:

"SO-55512"

customer
string

Only this customer's invoices.

Required string length: 1 - 100
Example:

"019e2b4c-7a1d-7c3e-9f20-5b8d4e6a1c30"

status
enum<string>
Available options:
open,
paid,
canceled
Example:

"open"

Response

A page of invoices

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