Get customer

GET

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

GET

/api/v2/customers/:id

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.getCustomerById("id");
8 }
9 main();

1 {
2   "id": "c1234567-89ab-4def-0123-456789abcdef",
3   "name": "Acme Corporation",
4   "legalName": "Acme Corporation LLC",
5   "email": "contact@acmecorp.com",
6   "phone": "+1-555-123-4567",
7   "website": "https://www.acmecorp.com",
8   "externalId": "ACME-2024-001",
9   "creationState": "active",
10   "churnDate": "2024-01-15T09:30:00Z",
11   "vatNumber": "US123456789",
12   "metadata": {
13     "industry": "Manufacturing",
14     "accountManager": "jane.doe@acmecorp.com"
15   },
16   "createdAt": "2023-11-01T08:00:00Z",
17   "updatedAt": "2024-04-20T15:45:00Z",
18   "billingAddress": {
19     "line1": "123 Elm Street",
20     "line2": "Suite 400",
21     "city": "Springfield",
22     "state": "IL",
23     "zipCode": "62704",
24     "country": "USA"
25   }
26 }

Get a customer by ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200

idstring

namestring

legalNamestring or null

emailstring

phonestring

websitestring

externalIdstring or null

creationStateenum

Allowed values:

churnDatedatetime or null

vatNumberstring or null

metadatamap from strings to any or null

createdAtdatetime

updatedAtdatetime

billingAddressobject or null

Authentication

Path parameters

Response

Errors