Billing

Get credit usage

Changed on

A customer-bound key or a RecruitMCP-Customer header sees only that customer's spend. A bound key's balance is its remaining daily cap, or null when the customer has no cap. An account key still sees the account balance.

Scope: account:read.

get/v1/usage

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/usage
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://recruitmcp.com/oauth/authorize, token URL https://recruitmcp.com/oauth/token, scopes: account:read)

Query parameters

group_by'day' | 'purpose' | 'api_key' | 'customer'

day, purpose, api_key, or customer. Default day.

fromstring date-time

Inclusive start.

tostring date-time

Inclusive end.

customer_idstring

Only spend inside this customer. Account keys only.

Headers

RecruitMCP-Version'2026-10-13'

API version. Defaults to the version the key was created with. Supported: 2026-10-13.

RecruitMCP-Customerstring

Act inside this customer (cus_…). Ignored for keys bound to a customer, which always act inside theirs.

Response

Usage buckets.

object'usage' required
customer_idstring nullable required

Customer this usage was scoped to. Null for the account.

balance_creditsinteger nullable required

Account balance, or the bound customer's remaining daily cap. Null when that customer has no cap.

daily_cap_creditsinteger nullable
group_by'day' | 'purpose' | 'api_key' | 'customer'
creditsobject

Changes

  • ad27b35513a6Revision changes
    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status

    • warning

      added the new approval_forced enum value to the / response property for the response status