Skip to main content
GET
/
v1
/
organizations
/
billing
/
usage
/
breakdown
Get Usage Breakdown
curl --request GET \
  --url https://api.mixpeek.com/v1/organizations/billing/usage/breakdown \
  --header 'Authorization: Bearer <token>'
{
  "billing_month": "<string>",
  "total_credits": 123,
  "total_cost_usd": 123,
  "by_operation": {},
  "by_extractor": {},
  "period_start": "2023-11-07T05:31:56Z",
  "period_end": "2023-11-07T05:31:56Z",
  "pending_credits": 0,
  "pending_by_operation": {}
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
billing_month
string | null

Billing month in YYYY-MM format (defaults to current month)

Example:

"2025-12"

Response

Successful Response

Response with detailed usage breakdown.

​
billing_month
string
required

Billing month (YYYY-MM)

Example:

"2025-12"

​
total_credits
integer
required

Total credits consumed

Example:

23450

​
total_cost_usd
number
required

Total cost in USD

Example:

23.45

​
by_operation
By Operation · object
required

Credits consumed by operation type

Example:
{
  "batch": 2450,
  "extractor": 15000,
  "search": 1000,
  "upload": 5000
}
​
by_extractor
By Extractor · object
required

Credits consumed by extractor

Example:
{
  "multimodal_extractor": 10000,
  "text_extractor": 5000
}
​
period_start
string<date-time>
required

Start of billing period

​
period_end
string<date-time>
required

End of billing period

​
pending_credits
number
default:0

Unflushed sub-credit usage accrued but not yet committed to by_operation. Micro-priced per-op usage (e.g. MVS writes/queries at ~0.001 credit each) accumulates here and rolls into by_operation in whole credits as it crosses 1 — so real activity is visible immediately, before a whole credit accrues (BACKE-790).

Example:

0.014

​
pending_by_operation
Pending By Operation · object

Unflushed fractional credits by operation type.

Example:
{ "mvs_query": 0.004, "mvs_write": 0.01 }