vocapableAI-agent minutes in the current billing period, whole and per agent
const url = 'https://api.vocapable.com/v1/usage/ai-minutes';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.vocapable.com/v1/usage/ai-minutes \ --header 'Authorization: Bearer <token>'The billable AI seconds of the subscription’s current Stripe billing period.
The seconds are exactly the ones the billing_period_estimate AI-minutes line prices -
invoice-eligible telephony_minutes, inbound receptionist calls included and separately
prepaid managed test calls excluded - split into what the rating engine has already
rated and the tail it has not reached yet, and attributed to the agent whose call
produced each row. A company with no subscription has no billing period: every figure
is null, never zero.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Successful Response
The AI-agent minutes in the current billing period, whole and per agent.
The same seconds the estimate’s “AI minutes” line prices: telephony_minutes rows
eligible for a Vocapable invoice (inbound receptionist calls included; separately
prepaid managed test calls excluded). They are AI-session seconds, billed per second
after a 30-second minimum per call - never the carrier’s own minutes, which a BYO
tenant’s carrier invoices directly.
rated_seconds are what the rating engine has already priced this period and
unrated_seconds the tail it has not reached yet (normally one tick deep); both are
null while the rating engine holds no state for the period. agents attributes each
row to the agent whose call produced it; unattributed_seconds is what no call or
campaign links to an agent, so the two always sum to billable_seconds.
object
One agent’s share of the period’s billable AI seconds.
object
Example
{ "state": "billing_period"}