Get an embed token for a custom view | Paid

⚠️ Experimental — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.

Mints a short-lived, customer-scoped token for embedding a published custom view. Call this from your server with your API key, then pass the returned token to the embed SDK. Organization-scoped views cannot be embedded per-customer — this returns a 400 (ORG_SCOPED_VIEW_NOT_EMBEDDABLE) for one.

⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet. Mints a short-lived, customer-scoped token for embedding a published custom view. Call this from your server with your API key, then pass the returned token to the embed SDK. Organization-scoped views cannot be embedded per-customer — this returns a 400 (`ORG_SCOPED_VIEW_NOT_EMBEDDABLE`) for one.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

displayIdstringRequired

Query parameters

customerIdstringRequired>=1 character

The customer to scope the view to: external id, Paid display id (cus_…), or internal id.

ttlSecondsintegerOptional

Token lifetime in seconds (capped at 3600).

Response

200

tokenstring

Short-lived signed token to pass to the embed SDK.

expiresAtdatetime

When the token expires (ISO 8601).

Errors

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.customViewsExperimental.getCustomViewEmbedToken("view_9f8b7c6d", {
8	customerId: "cus_12345abcde",
9	ttlSeconds: 1800,
10	});
11	}
12	main();

1	{
2	"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjdXN0b21lcl9pZCIsImV4cCI6MTY4OTY4MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
3	"expiresAt": "2024-01-15T09:30:00Z"
4	}