Check customer entitlement for an event | Paid

AuthorizationBearer

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

customerIdstringRequired

The customer ID

event_namestringRequired

The name of the usage event to check entitlement for

viewenumOptionalDefaults to active_only

Filter view - ‘all’ returns all entitlements regardless of status, ‘active_only’ returns only currently active entitlements with available credits

Allowed values:

Success response

entitledboolean

Whether the customer is entitled to the specified event

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.customers.checkEntitlement("customerId", {
9	eventName: "event_name",
10	});
11	}
12	main();