Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
invoices

Lists invoices with cursor pagination and optional filters (customer, entity, status, processor). Pass start_cursor: "" (or omit) for the first page; use next_cursor from a prior response for subsequent pages.

post/v1/invoices.list

Headers

x-api-versionstring required

Request body

start_cursorstring

Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.

limitinteger

Number of items to return. Default 50, hard ceiling 5000.

customer_idstring

Filter invoices to a single customer by ID.

entity_idstring

Filter invoices to a single entity by ID. Must be provided together with customer_id, since entity IDs are only unique per customer.

statusstring[]

Filter by invoice status (draft, open, paid, void, uncollectible).

processor_typesstring[]

Filter by billing processor (stripe, revenuecat). Invoices recorded before processor tracking count as stripe.

Example request

{
  "start_cursor": "",
  "limit": 10,
  "customer_id": "cus_123",
  "status": [
    "open",
    "paid"
  ]
}

Response

OK

next_cursorstring nullable required

Opaque cursor for the next page. Null when there are no more results.

Example response

{
  "list": [
    {
      "id": "inv_2b3c4d5e6f7g8h",
      "customer_id": "cus_123",
      "entity_id": null,
      "plan_ids": [
        "pro_plan"
      ],
      "stripe_id": "in_1A2B3C4D5E6F7G8H",
      "processor_type": "stripe",
      "status": "paid",
      "total": 29.99,
      "amount_paid": 29.99,
      "refunded_amount": 0,
      "currency": "usd",
      "created_at": 1759247877000,
      "hosted_invoice_url": "https://invoice.stripe.com/i/acct_123/test_456"
    }
  ],
  "next_cursor": null
}