Create customer alias by external ID | Paid

Create an alternate external identifier for 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.

Body

aliasstringRequired1-255 characters

Alternate external identifier that should resolve to this customer.

namestringOptional<=120 characters

Optional display name for this alias.

descriptionstringOptional<=500 characters

Optional note describing where this alias comes from.

201

aliasstring

Alternate external identifier that resolves to the customer.

customerIdstring

Paid customer display ID this alias resolves to.

namestring or null

descriptionstring or null

createdAtdatetime

updatedAtdatetime

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict 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.createCustomerAliasByExternalId("customer_123", {
8	body: {
9	alias: "child-customer-1",
10	},
11	});
12	}
13	main();

1	{
2	"alias": "child-customer-1",
3	"customerId": "cus_abc123",
4	"name": "Child Account 1",
5	"description": "Identifier used by a downstream CRM workspace.",
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-01-15T09:30:00Z"
8	}