For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inGet Paid
DocumentationAPI Reference
DocumentationAPI Reference
  • Introduction
    • Overview
  • API Reference
      • GETList customers
      • POSTCreate a new customer
      • GETGet customer by ID
      • PUTUpdate customer
      • DELDelete customer
      • GETCheck customer entitlement for an event
      • GETGet customer entitlements
      • GETGet customer by external ID
      • PUTUpdate customer by external ID
      • DELDelete customer by external ID
      • GETFetch cost traces for a customer by external ID
      • GETFetch usage summaries for a customer by external ID
      • GETList customer payment methods by external ID
      • POSTCreate customer payment method by external ID
      • DELDelete customer payment method by external ID
LogoLogo
Log inGet Paid
API Referencecustomers

Get customer by ID

GET
https://api.agentpaid.io/api/v1/customers/:customerId
GET
/api/v1/customers/:customerId
1import { PaidClient } from "@paid-ai/paid-node";
2
3async function main() {
4 const client = new PaidClient({
5 token: "YOUR_TOKEN_HERE",
6 });
7 await client.customers.get("customerId");
8}
9main();
200customers_get_example
1{
2 "id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
3 "organizationId": "string",
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 "website": "https://acme.com",
12 "billingAddress": {
13 "line1": "123 Main St",
14 "city": "Anytown",
15 "state": "CA",
16 "zipCode": "12345",
17 "country": "US",
18 "line2": "Apt 4B"
19 }
20}
Was this page helpful?
Previous

Update customer

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

customerIdstringRequired

Response

Success response
idstring
organizationIdstring
namestring
externalIdstring
phonestring
employeeCountdouble
annualRevenuedouble
taxExemptStatusenum
Allowed values:
creationSourceenum
Allowed values:
creationStateenum
Allowed values:
websitestring
billingAddressobject
metadataobject
Flexible JSON field for storing custom metadata about the customer