customers

Check customer entitlement for an event

get/customers/{customerId}/entitlement

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/customers/{customerId}/entitlement
  • Auth: HTTP bearer

Path parameters

customerIdstring required

The customer ID

Query parameters

event_namestring required

The name of the usage event to check entitlement for

view'all' | 'active_only'

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

Response

Success response

entitledboolean required

Whether the customer is entitled to the specified event

Changes

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