v1

latestOpenAPI 3.1.02026-08-042453938.9 KB

Customers

Get a customer

Retrieve a customer by their ID. Requires a secret key (sk_*).

get/v1/customers/{id}

Path parameters

idstring required

Customer ID

Response

Customer details

idstring required

Internal customer ID

businessIdstring required

Business ID this customer belongs to

namestring nullable

Customer display name

externalCustomerIdstring nullable

Your system customer ID (null if created with onchainAddress only)

stripeCustomerIdstring nullable

Stripe customer ID linked via Connect or migration

onchainAddressstring nullable

Smart account address (null for internal customers)

emailstring email nullable

End-customer email used for invoice receipt delivery (null if not set)

isInternalboolean required

Internal customer (visibility only, no billing)

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

Customer status

metadataobject nullable

Arbitrary metadata attached to the customer

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "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"
}