Skip to main content
GET
List invoices (cursor pagination)

Overview

Use this endpoint to list invoices with Stripe-style cursor pagination and optional expand fields.

Authentication

  • Merchant server auth: x-api-key or Authorization: Bearer <jwt>

Request

SDK

cURL

Response

Errors

  • 400 invalid cursor or query parameters
  • 401 missing/invalid merchant auth

Examples

Cursor pagination:
Receipt lookup by payer wallet:
Next: Retrieve an invoice

Authorizations

x-api-key
string
header
required

API key for server-to-server operations (scope=merchant or commerce)

Query Parameters

limit
integer
default:10

Max number of invoices to return.

Required range: 1 <= x <= 100
starting_after
string<uuid>

Cursor (return invoices created before this ID).

ending_before
string<uuid>

Cursor (return invoices created after this ID).

status
string

Comma-separated invoice statuses.

invoice_type
string

Comma-separated invoice types (product keys are locked to products).

customer_id
string

Filter by merchant customer ID.

payer_wallet_address
string

Filter by payer wallet address (matches any invoice payment).

payer_wallet_network
enum<string>

Optional; requires payer_wallet_address.

Available options:
ethereum,
base,
solana,
avalanche,
ton,
bsc,
arbitrum,
optimism,
cardano,
sui
environment
enum<string>

Filter by network environment.

Available options:
mainnet,
devnet
created_gte
integer

Return invoices created on/after this time.

created_lte
integer

Return invoices created on/before this time.

expand
string

Comma-separated expansions (latest_payment, payments).

payments_limit
integer
default:10

Max payments per invoice when expand includes payments.

Required range: 1 <= x <= 100

Response

Invoice list retrieved successfully

object
string
Example:

"list"

data
object[]
has_more
boolean