Create a customer portal session | Paid

Creates a portal session for the customer. Returns a short-lived URL to the customer portal.

AuthorizationBearer

API Key authentication using Bearer token

Body

customerIdstringOptional

The Paid customer ID (display ID or UUID). Either this or externalCustomerId must be provided.

externalCustomerIdstringOptional

Your external customer ID. Either this or customerId must be provided.

returnUrlstringOptionalformat: "uri"

expiresAtdatetimeOptional

201

idstring

customerIdstring

urlstring

statusenum

Allowed values:

returnUrlstring or null

expiresAtdatetime

createdAtdatetime

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.customerPortals.createCustomerPortal({});
8	}
9	main();

1	{
2	"id": "portal_9f8b7c6d5e4a3b2c1d0e",
3	"customerId": "cus_abc123",
4	"url": "https://customer-portal.agentpaid.io/session/portal_9f8b7c6d5e4a3b2c1d0e",
5	"status": "active",
6	"returnUrl": "https://myapp.com/settings",
7	"expiresAt": "2024-01-15T09:30:00Z",
8	"createdAt": "2024-01-15T08:30:00Z"
9	}