Billing

Get the caller's org cost breakdown

Return costs broken down by category (default), agent, or user.

Delegates to :func:~app.services.billing._queries.get_org_breakdown.

get/billing/breakdown

Request

  • Base URL: https://api-docs.jackhamr.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.jackhamr.ai/billing/breakdown
  • Auth: none declared

Query parameters

period_startstring date-time nullable

Start of period (ISO 8601)

period_endstring date-time nullable

End of period (ISO 8601)

group_bystring

Group by: category, agent, or user

Response

Successful Response

organization_idstring required
period_startstring date-time required
period_endstring date-time required
group_bystring
categoriesobject[] nullable
agentsobject[] nullable
usersobject[] nullable

Changes

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