API Referenceusage

Check if usage is allowed for a customer and product

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
externalCustomerIdstringRequired
External customer ID
externalProductIdstringRequired

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

Response

Usage check response
allowedbooleanOptional
Whether usage is allowed
messagestringOptional

Human-readable message about the usage check result

eventNamestringOptional

Event name (only present when usage is not allowed)

availabledoubleOptional

Available credits (only present for PrepaidCredits when insufficient)

eventsQuantitydoubleOptional

Current events quantity (only present when usage exceeds limit)

limitdoubleOptional

Usage limit (only present when usage exceeds limit)

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error