---
title: "Plan, credits and this credential's scopes, caps and spend."
method: GET
path: "/v1/account"
---

# Plan, credits and this credential's scopes, caps and spend.

`GET /v1/account`

## Request

- Base URL: `https://api.lumeta.ai`
- URL: `https://api.lumeta.ai/v1/account`
- Auth: HTTP bearer

## Response `200`

OK

- Account
  - `user` object
    - `id` integer
    - `email` string
    - `name` string
    - `plan` integer: The access level, as in a model's `min_plan`.
    - `plan_name` string: The plan this account is on, by name (two plans can share an access level).
    - `current_project` string, nullable
  - `credits` object
    - `remaining` integer: Everything you can spend: monthly, purchased and expiring.
    - `monthly_remaining` integer
    - `purchased` integer
    - `expiring` object[]: Credits that expire, such as a friend's gift, soonest first. Counted in `remaining`; spent before your monthly credits when they expire sooner, and always before purchased ones.
      - `credits` integer: Left to spend.
      - `expires_at` string: ISO 8601, UTC.
      - `reason` string: What they are for, e.g. `gift_welcome`.
    - `monthly_allowance` integer
    - `cycle_refreshes_at` string
  - `credential` object
    - `id` integer
    - `kind` string
    - `name` string
    - `scopes` string[]
    - `credit_cap_daily` integer, nullable
    - `credit_cap_monthly` integer, nullable
    - `spent_today` integer
    - `spent_this_month` integer
    - `cap_remaining` integer, nullable
    - `allow_auto_topup` boolean
    - `expires_at` string, nullable
  - `credits_remaining` integer
  - `cap_remaining` integer, nullable

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/lumeta/apis/lumeta-api.md) · [All operations](https://skmtc.dev/lumeta/apis/lumeta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lumeta/apis/lumeta-api/revisions/1f3b5e5b87f6?raw)