Get customer by external ID | Paid

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

externalIdstringRequired

Success response

idstring

organizationIdstring

namestring

externalIdstring or null

phonestring or null

employeeCountdouble or null

annualRevenuedouble or null

taxExemptStatusenum or null

Allowed values:

creationSourceenum or null

Allowed values:

creationStateenum or null

Allowed values:

websitestring or null

billingAddressobject or null

1	{
2	"id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
3	"organizationId": "organizationId",
4	"name": "Acme, Inc.",
5	"externalId": "acme-inc",
6	"phone": "123-456-7890",
7	"employeeCount": 100,
8	"annualRevenue": 1000000,
9	"taxExemptStatus": "exempt",
10	"creationSource": "api",
11	"creationState": "active",
12	"website": "https://acme.com",
13	"billingAddress": {
14	"line1": "123 Main St",
15	"city": "Anytown",
16	"state": "CA",
17	"zipCode": "12345",
18	"country": "US",
19	"line2": "Apt 4B"
20	}
21	}

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	const client = new PaidClient({ token: "YOUR_TOKEN" });
4	await client.customers.getByExternalId("externalId");