Skip to main content
GET
List Invoices

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payment:basic:read

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Sorgu Parametreleri

account_id
string
status
enum<string>
Mevcut seçenekler:
draft,
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
statuses
enum<string>[]

Only invoices in any of these statuses. Repeat the parameter to pass several. Combined with status when both are sent.

Mevcut seçenekler:
draft,
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
overdue
boolean
scheduled
boolean

Set to true for drafts with a scheduled send, which are the invoices with a scheduled_send_at. Set to false for every other invoice. Only a draft can be scheduled. An open invoice is not scheduled, even with a scheduled_charge_at. A draft that sends on its due date (sends_on_due_date) is not scheduled. Omit to include both.

member_id
string
product_id
string
variant_id
string

Only invoices that bill this variant, prefixed plan_. An invoice matches when the variant is any of its items.

query
string

Text to find invoices by. It matches the invoice number, the invoice ID, and the customer's name, username, or email address. A number matches with or without its prefix and leading zeros. A name matches on any part. An email address matches from its start. The match ignores letter case. % and _ match literally. Combined with the other filters. Name matches need member:basic:read. Email matches need member:email:read.

Maximum string length: 255
created_after
string<date-time>
created_before
string<date-time>
order
enum<string>
varsayılan:created_at

Field to sort by. Sorting by due_at or scheduled_send_at puts invoices without that date last in both directions.

Mevcut seçenekler:
created_at,
due_at,
status,
scheduled_send_at
direction
enum<string>
varsayılan:desc
Mevcut seçenekler:
asc,
desc
first
integer
varsayılan:20

Number of results to return from the start of the range.

Gerekli aralık: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Gerekli aralık: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

Yanıt

invoices

data
object[]
gerekli
page_info
object
gerekli