v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Charges

List charges

Retrieve all charges for your business, sorted by creation date (newest first).

get/v1/charges

Query parameters

limitinteger

Maximum number of charges to return

offsetinteger

Number of charges to skip (for pagination)

status'PENDING' | 'PENDING_SETTLEMENT' | 'CONFIRMED' | 'FAILED' | 'REFUNDED' | 'REFUND_PENDING'

Filter by status

customerIdstring

Filter by customer ID

Response

List of charges

countinteger

Total number of charges returned

Example response

{
  "data": [
    {
      "id": "chg_abc123def456",
      "usageId": "usg_xyz789",
      "customerId": "cus_abc123",
      "customer": {
        "id": "cus_abc123",
        "onchainAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f00000",
        "externalCustomerId": "user_123"
      },
      "usageEvent": {
        "id": "usg_xyz789",
        "type": "api_call",
        "quantity": "100",
        "metadata": {
          "endpoint": "/v1/chat"
        }
      },
      "amountUsdc": "0.100000",
      "amountToken": "100000",
      "txHash": "0x1234567890abcdef...",
      "blockNumber": "12345678",
      "status": "CONFIRMED",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "confirmedAt": "2024-01-15T10:30:05.000Z"
    }
  ],
  "count": 42
}