v1

latestOpenAPI 3.1.02026-08-042453938.9 KB

Customers

List customers

List all customers for your business. Requires a secret key (sk_*). Returns up to 100 customers sorted by creation date (newest first).

get/v1/customers

Query parameters

limitinteger

Maximum number of customers to return

offsetinteger

Number of customers to skip (for pagination)

status'ACTIVE' | 'LOW_BALANCE' | 'PAUSED'

Filter by customer status

onchainAddressstring

Filter by on-chain address

isInternalboolean

Filter by internal customers (true = internal only, false = billing customers only)

Response

List of customers

countinteger

Number of customers returned

Example response

{
  "data": [
    {
      "id": "cus_abc123def456",
      "businessId": "biz_abc123",
      "name": "Acme Logistics",
      "externalCustomerId": "user_789",
      "stripeCustomerId": "cus_StripeXYZ",
      "onchainAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f00000",
      "email": "billing@acme.com",
      "status": "ACTIVE",
      "metadata": {
        "plan": "pro",
        "source": "signup"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ]
}