Check if usage is allowed for a customer and product | Paid

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

externalCustomerIdstringRequired

External customer ID

externalProductIdstringRequired

External product ID (the external ID of the product/agent)

Usage check response

allowedboolean or null

Whether usage is allowed

messagestring or null

Human-readable message about the usage check result

eventNamestring or null

Event name (only present when usage is not allowed)

availabledouble or null

Available credits (only present for PrepaidCredits when insufficient)

eventsQuantitydouble or null

Current events quantity (only present when usage exceeds limit)

limitdouble or null

Usage limit (only present when usage exceeds limit)

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	async function main() {
4	const client = new PaidClient({
5	environment: "https://api.agentpaid.io/api/v1",
6	token: "YOUR_TOKEN_HERE",
7	});
8	await client.usage.checkUsage({
9	externalCustomerId: "globex-corp",
10	externalProductId: "globex-email-service",
11	});
12	}
13	main();