List customer aliases by external ID

GET

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

List alternate external identifiers that resolve to a customer by external ID.

AuthorizationBearer

API Key authentication using Bearer token

externalIdstringRequired

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

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

200

datalist of objects

paginationobject

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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.listCustomerAliasesByExternalId("customer_123", {});
8	}
9	main();

1	{
2	"data": [
3	{
4	"alias": "vip-customer-789",
5	"customerId": "cus_9f8e7d6c5b4a3",
6	"name": "Acme Corporation",
7	"description": "Primary corporate account for Acme Corp.",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-04-10T14:45:00Z"
10	}
11	],
12	"pagination": {
13	"limit": 10,
14	"offset": 0,
15	"total": 3,
16	"hasMore": true
17	}
18	}