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

Whether usage is allowed

messagestring

Human-readable message about the usage check result

eventNamestring

Event name (only present when usage is not allowed)

availabledouble

Available credits (only present for PrepaidCredits when insufficient)

eventsQuantitydouble

Current events quantity (only present when usage exceeds limit)

limitdouble

Usage limit (only present when usage exceeds limit)

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	const url = 'https://api.agentpaid.io/api/v1/usage/check-usage';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"externalCustomerId":"globex-corp","externalProductId":"globex-email-service"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"allowed": true,
3	"message": "usage within allowance"
4	}