Get product by external ID

GET

https://api.agentpaid.io/api/v2/products/external/:externalId

Get a product by external ID

AuthorizationBearer

API Key authentication using Bearer token

externalIdstringRequired

200

idstring

namestring

descriptionstring or null

createdAtdatetime

updatedAtdatetime

activeboolean

productCodestring or null

externalIdstring or null

archivedAtdatetime or null

metadatamap from strings to any or null

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.products.getProductByExternalId("externalId");
8	}
9	main();

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"name": "Premium Health Insurance Plan",
4	"description": "Comprehensive health insurance coverage with dental and vision benefits.",
5	"createdAt": "2024-01-15T09:30:00Z",
6	"updatedAt": "2024-04-10T14:45:00Z",
7	"active": true,
8	"productCode": "PHI-2024-01",
9	"externalId": "EXT-987654321",
10	"archivedAt": null,
11	"metadata": {
12	"category": "Health Insurance",
13	"region": "US",
14	"coverageLevel": "Premium"
15	}
16	}