Account and usage: GET /api/v1/account, /usage

Updated September 23, 2026 · API version 2026-09-01 · This page as JSON

GET /api/v1/account returns the caller's credit balance, verification state and key details; GET /api/v1/usage returns the credit ledger. Both need a key and cost nothing, so an agent can check its budget before a batch of searches.

What does /account return?

{
  "object": "account",
  "request_id": "req_7f3k2m9x1q0a4b8c",
  "id": "usr_4k2m9x1q0a4b8c7f3k",
  "email": "[email protected]",
  "name": "Sam Rivera",
  "email_verified": false,
  "credits_remaining": 96,
  "low_balance": false,
  "verification_bonus_available": 100,
  "api_key": {
    "id": "key_9x1q0a4b8c7f3k2m",
    "name": "production agent",
    "scopes": [
      "search:read",
      "catalog:read",
      "coupons:read"
    ]
  },
  "dashboard": "https://cart-route.com/dashboard"
}

low_balance is true below 20 credits. verification_bonus_available is the number of credits the account will receive when its email is confirmed (0 once granted).

What does /usage return?

{
  "object": "usage",
  "credits_remaining": 96,
  "entries": [
    {
      "id": "led_1q0a4b8c7f3k2m9x",
      "at": "2026-09-23T10:41:07.512Z",
      "delta": -1,
      "balance_after": 96,
      "reason": "search",
      "description": "Product search"
    },
    {
      "id": "led_0a4b8c7f3k2m9x1q",
      "at": "2026-09-23T10:02:55.103Z",
      "delta": 100,
      "balance_after": 100,
      "reason": "signup_grant",
      "description": "Welcome grant"
    }
  ]
}

Entries are newest first. limit is 1–200, default 50. Reasons: signup_grant, verify_grant, search, product_lookup, price_history, coupon_lookup, plan_builder, plan_scale, admin_adjustment, refund.