Billing

Get a user's billing state

Returns a user's current billing state (admin only), identified by id: plan, period, included, used and remaining usage, overage_credits, daily usage on the UTC day, subscription price and any pending_plan. A daily_credit_limit of 0 means no daily cap. Returns 404 when the user's billing state has not been initialised.

get/admin/billing/users/{id}/state

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/admin/billing/users/{id}/state
  • Auth: API key in header x-api-key

Path parameters

idstring required

User id

Headers

x-api-keystring required

Admin API key required unless an Admin JWT is already present

Response

User billing state

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "allow_overage": true,
    "created_at": "2026-04-01T00:00:00Z",
    "credits_remaining": 398750,
    "credits_used": 1250,
    "currency": "usd",
    "daily_credit_limit": 25000,
    "daily_credits_remaining": 24100,
    "daily_credits_used": 900,
    "daily_key": "2026-04-16",
    "expected_subscription_amount_cents": 7900,
    "expected_total_amount_cents": 7900,
    "included_credits": 400000,
    "pending_plan": "Starter",
    "pending_plan_effective_at": "2026-05-01T00:00:00Z",
    "period_end": "2026-05-01T00:00:00Z",
    "period_key": "2026-04",
    "period_start": "2026-04-01T00:00:00Z",
    "plan": "Pro",
    "pricing_source": "plan_default",
    "subscription_price_cents": 7900,
    "updated_at": "2026-04-16T10:00:00Z",
    "user_id": "user-1"
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.