Skip to main content
GET
List Invoices

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

x-entity-id
string<uuid>

Optional entity_id to scope requests to a specific entity.

Response

200 - application/json

Successful Response

id
string<uuid>
required

The unique identifier for the invoice.

customer_id
string<uuid>
required

The unique identifier for the customer.

status
enum<string>
required

The current status of the invoice.

Available options:
Draft,
Open,
Pending,
Scheduled,
Partially Paid,
Paid,
Canceled,
Expired,
Overdue
amount
string
required

The total amount of the invoice.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
amount_paid
string
required

The amount that has been paid on the invoice.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
amount_due
string
required

The remaining amount due on the invoice.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
line_item_ids
string<uuid>[]
required

List of line item IDs associated with the invoice.

payment_method_types
enum<string>[]
required

List of allowed payment method types for the invoice.

Available options:
BANK_TRANSFER,
CARD,
ACH_DIRECT_DEBIT,
INTERNATIONAL_WIRE,
USDC_ETHEREUM,
USDC_SOLANA,
USDC_BASE,
USDC_XDC,
USDT_ETHEREUM,
USDT_SOLANA,
CASH_SOLANA
send_email_on_creation
boolean
required

Whether to send an email upon invoice creation.

additional_recipient_emails
string[]
required

List of additional email addresses to receive the invoice.

collection_account_id
string<uuid>
required

The collection account ID where funds will be collected.

created_at
string<date-time>
required

The timestamp when the invoice was created.

name
string | null

The name of the invoice.

invoice_number
string | null

The public-facing invoice number.

invoice_date
string<date> | null

The date the invoice is scheduled to be sent.

due_date
string<date> | null

The date the invoice payment is due.

note
string | null

A note associated with the invoice.

updated_at
string<date-time> | null

The timestamp when the invoice was last updated.

paid_at
string<date-time> | null

The timestamp when the invoice was fully paid.

canceled_at
string<date-time> | null

The timestamp when the invoice was canceled.

sent_at
string<date-time> | null

The timestamp when the invoice was sent.

expired_at
string<date-time> | null

The timestamp when the invoice expired.