Billing

Get the credit balance

Changed on

Account balance by source. A customer-bound key receives that customer's remaining daily cap, or null when the customer has no cap. It does not receive the account pool, buckets, or subscription.

Scope: account:read.

get/v1/billing/balance

Request

  • Base URL: https://api.recruitmcp.com
  • URL: https://api.recruitmcp.com/v1/billing/balance
  • 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)

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

Balance.

balance_creditsinteger nullable required

Account balance. A customer-bound key gets that customer's remaining daily cap, or null when the customer has no cap.

by_sourceobject

plan, topup, free, promo (launch bonus), admin, refund, legacy. Empty for a customer-bound key.

bucketsobject[]
rulesobject
subscriptionobject nullable

Example response

{
  "balance_credits": 1250,
  "by_source": {
    "free": 1250
  },
  "buckets": [
    {
      "source": "free",
      "remaining_credits": 1250
    }
  ],
  "upcoming_expiries": [],
  "next_expiry": null
}

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