PlatformDocs
MCP server

list_invoices

The account's invoices, newest first: date, amount, refunded amount, currency, status (paid, open, void, uncollectible, refunded, partially_refunded), description (what it was for), a link to the PDF and hosted (the invoice's web page, where an open one can be paid).

View as Markdown

List invoices · Read-only

The account's invoices, newest first: date, amount, refunded amount, currency, status (paid, open, void, uncollectible, refunded, partially_refunded), description (what it was for), a link to the PDF and hosted (the invoice's web page, where an open one can be paid). Paged: when hasMore is true, pass nextCursor as startingAfter. Account owners and billing admins only. Free.

ConnectionAccount-owner URL or OAuth (not a team member URL)

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringNoanyOptional, kept for older callers: invoices belong to the account, so the list is the same for every website.
limitintegerNo1–50 · default 10Invoices per page, a whole number from 1 to 50 (default 10).
startingAfterstringNoanyFor the next page: the nextCursor from the previous answer. Leave empty for the newest invoices.

Tool definition

What your assistant receives from tools/list:

{
  "name": "list_invoices",
  "title": "List invoices",
  "annotations": {
    "title": "List invoices",
    "readOnlyHint": true,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Optional, kept for older callers: invoices belong to the account, so the list is the same for every website."
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 50,
        "default": 10,
        "description": "Invoices per page, a whole number from 1 to 50 (default 10)."
      },
      "startingAfter": {
        "type": "string",
        "description": "For the next page: the nextCursor from the previous answer. Leave empty for the newest invoices."
      }
    }
  }
}

On this page