List customers

GET

https://api.agentpaid.io/api/v2/customers/

GET

/api/v2/customers/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.customers.listCustomers({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "cus_9f8b7c6d",
5       "name": "Acme Corporation",
6       "legalName": "Acme Corporation Ltd.",
7       "email": "contact@acmecorp.com",
8       "phone": "+1-555-123-4567",
9       "website": "https://www.acmecorp.com",
10       "externalId": "ACME-2024-001",
11       "billingAddress": {
12         "line1": "123 Elm Street",
13         "line2": "Suite 400",
14         "city": "Springfield",
15         "state": "IL",
16         "zipCode": "62704",
17         "country": "US"
18       },
19       "creationState": "draft",
20       "status": "active",
21       "churnDate": null,
22       "vatNumber": "US123456789",
23       "metadata": {
24         "industry": "Manufacturing",
25         "accountManager": "jane.doe"
26       },
27       "defaultCurrency": "USD",
28       "connections": {
29         "stripe": {
30           "customerId": "cus_stripe_7h3k9l2m"
31         }
32       },
33       "createdAt": "2024-01-15T09:30:00Z",
34       "updatedAt": "2024-04-10T14:45:00Z"
35     }
36   ],
37   "pagination": {
38     "limit": 1,
39     "offset": 1,
40     "total": 25,
41     "hasMore": true
42   }
43 }

Get a list of customers for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

namestringOptional>=1 character

Search by customer name (case-insensitive, matches anywhere in the name).

statusenumOptional

Filter by customer status. churned: customers marked as churned. active: everyone else.

Allowed values:

creationStateenumOptional

Filter by creation state: draft or active.

Allowed values:

createdAtFromstringOptional

Only customers created on or after this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

createdAtTostringOptional

Only customers created on or before this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

externalIdstringOptional>=1 character

Filter by your external customer ID (exact match).

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error