Get customer by external ID

GET

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

GET

/api/v2/customers/external/:externalId

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

1 {
2   "id": "c3f9a1d2-7b4e-4f8a-9d3e-2a1b5f6c7d8e",
3   "name": "GreenTech Solutions",
4   "legalName": "GreenTech Solutions LLC",
5   "email": "contact@greentechsolutions.com",
6   "phone": "+1-415-555-0198",
7   "website": "https://www.greentechsolutions.com",
8   "externalId": "GT-2024-0001",
9   "creationState": "active",
10   "churnDate": "2024-01-15T09:30:00Z",
11   "vatNumber": "US123456789",
12   "metadata": {
13     "industry": "Renewable Energy",
14     "accountManager": "jane.doe"
15   },
16   "createdAt": "2023-11-20T14:45:00Z",
17   "updatedAt": "2024-04-10T11:20:00Z",
18   "billingAddress": {
19     "line1": "1234 Elm Street",
20     "line2": "Suite 500",
21     "city": "San Francisco",
22     "state": "CA",
23     "zipCode": "94107",
24     "country": "USA"
25   }
26 }

Get a customer by external ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

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