Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.billing.io/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cus_1a2b3c4d5e",
      "org_id": "<string>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "external_id": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}
Returns a paginated list of customers. Supports searching by email, name, or external_id. 
curl "https://api.billing.io/v1/customers?limit=10&search=alice" \
  -H "Authorization: Bearer $BILLING_API_KEY"

Authorizations

​
Authorization
string
header
required

Use your secret API key as a Bearer token. Keys are prefixed: sk_live_ (production) or sk_test_ (sandbox).

Query Parameters

​
search
string

Search by email, name, or external_id

​
limit
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0

Response

Customer list

​
data
object[]
​
has_more
boolean
​
next_cursor
string | null