List Clerk billing statements

List billing statements in a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/billing/statements

https://api.vee3.io/v1/clerk/billing/statements

5 tokens

List billing statements in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.list_billing_statements

Parameters4 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of billing statements to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of billing statements to skip before returning results.

Default: 0 · min 0

Response8 fields

billing_statementsarrayitems

6 fields

Billing statements in the connected Clerk application.

idstring

Clerk billing statement id.

statusstring

Statement status.

timestampinteger

Unix timestamp in milliseconds for the statement.

payer_idstring

Payer id (user_... or org_...) for the statement.

grand_total_amountinteger

Grand total amount in cents.

grand_total_currencystring

ISO currency code for the grand total.

total_countinteger

Total number of billing statements matching the query.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/billing/statements"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "paginated": False
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Billing statements from a connected Clerk application.

billing_statement_list.json

{
  "billing_statements": [
    {
      "id": "stmt_2abc123",
      "status": "paid",
      "timestamp": 1710000000000,
      "payer_id": "user_2abc123",
      "grand_total_amount": 2000,
      "grand_total_currency": "usd"
    }
  ],
  "total_count": 1
}