usage

Check if usage is allowed for a customer and product

post/usage/check-usage

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/usage/check-usage
  • Auth: HTTP bearer

Request body

externalCustomerIdstring required

External customer ID

externalProductIdstring required

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

Response

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)

availablenumber double

Available credits (only present for PrepaidCredits when insufficient)

eventsQuantitynumber double

Current events quantity (only present when usage exceeds limit)

limitnumber double

Usage limit (only present when usage exceeds limit)

Changes

No recorded changes to this operation across all 1 revision of this API.