Get customer by external ID | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.getCustomerByExternalId("customer_123");
}
main();

{
  "id": "cus_9f8b7c6d",
  "name": "Acme Corporation",
  "legalName": "Acme Corporation Ltd.",
  "email": "contact@acmecorp.com",
  "phone": "+1-555-123-4567",
  "website": "https://www.acmecorp.com",
  "externalId": "customer_123",
  "billingAddress": {
    "line1": "123 Elm Street",
    "line2": "Suite 400",
    "city": "Springfield",
    "state": "IL",
    "zipCode": "62704",
    "country": "US"
  },
  "creationState": "active",
  "churnDate": null,
  "vatNumber": "US123456789",
  "metadata": {
    "industry": "Manufacturing",
    "accountManager": "jane.doe"
  },
  "defaultCurrency": "USD",
  "createdAt": "2023-11-20T14:22:00Z",
  "updatedAt": "2024-04-10T10:15:00Z"
}

Get a customer by external ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Customer ID from the integrator’s system, stored on Paid as externalId.

Response

200

idstring

Stable Paid customer display ID. Use this value as the {id} path parameter for customer routes, for example GET /api/v2/customers/cus_abc123/state.

namestring

legalNamestring or null

emailstring

phonestring

websitestring

externalIdstring or null

billingAddressobject

Customer billing address, or null when no address is set.

creationStateenum

churnDatedatetime or null

vatNumberstring or null

metadatamap from strings to any or null

defaultCurrencystringformat: "^[A-Z]{3}$"

ISO 4217 currency code, for example USD, EUR, or GBP.

createdAtdatetime

updatedAtdatetime

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error