List Clerk billing statement payment attempts

List payment attempts for a billing statement.

← All Clerk endpoints · Capability overview

GET/v1/clerk/billing/statements/{statement_id}/payment-attempts

https://api.vee3.io/v1/clerk/billing/statements/{statement_id}/payment-attempts

5 tokens

List payment attempts for a billing statement.

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_statement_payment_attempts

Parameters5 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 payment attempts to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of payment attempts to skip before returning results.

Default: 0 · min 0

statement_idstringRequired

Clerk billing statement id.

Response7 fields

payment_attemptsarrayitems

5 fields

Payment attempts for the billing statement.

idstring

Clerk billing payment attempt id.

statusstring

Payment attempt status.

timestampinteger

Unix timestamp in milliseconds for the payment attempt.

amountinteger

Payment attempt amount in cents.

currencystring

ISO currency code for the payment attempt.

total_countinteger

Total number of payment attempts for the statement.

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/{statement_id}/payment-attempts"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "statement_id": "stmt_2abc123"
}

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

Example responses1 example

200Payment attempts for a billing statement.

payment_attempt_list.json

{
  "payment_attempts": [
    {
      "id": "pa_2abc123",
      "status": "succeeded",
      "timestamp": 1710000000000,
      "amount": 2000,
      "currency": "usd"
    }
  ],
  "total_count": 1
}