# Get key, balance, and plan

`GET https://api.paxalabs.com/v1/me`

GET /v1/me reports the presented key, the live credit balance in both buckets, and the effective plan with its rate limit and concurrency.

Poll this endpoint when reconciling usage. `credits_spent` can lag live spend by up to 5 minutes.

## Headers

- `authorization` (Bearer pxa_..., required): Authorization: Bearer pxa_... (recommended).
- `x-api-key` (pxa_..., optional): Alternative to the Authorization header. Ignored when Authorization is present.

See authentication at https://paxalabs.com/docs/authentication.

## Response

- `key` (object, required): The API key that authenticated this request.
  - `key.id` (string, required): Key id.
  - `key.name` (string, required): The label given to the key at creation.
  - `key.key_start` (string, required): First characters of the key, for display.
  - `key.credit_limit` (number or null, required): Spending cap for this key in credits; null means uncapped.
  - `key.credits_spent` (number, required): Credits this key has spent, exact to a hundredth (may lag live spend by up to 5 minutes).
  - `key.created_at` (string, required): Creation time, ISO 8601.
  - `key.last_used_at` (string or null, required): Last verified use, ISO 8601; null when never used.
- `balance` (object, required): Live credit balance of the account, exact to a hundredth of a credit.
  - `balance.wallet` (number, required): Purchased and granted credits; never expire.
  - `balance.plan` (number, required): Monthly plan credits; reset each billing period and spend first.
  - `balance.total` (number, required): wallet plus plan.
- `plan` (object, required): The effective plan.
  - `plan.key` (string, required): Plan key: "free", "starter", "standard", or "pro".
  - `plan.rpm` (integer or null, required): Requests per minute the plan allows; null means no limit. One window covers the whole account, across every product.
  - `plan.concurrency` (integer, required): Concurrent requests the plan allows, counted per product. An open live connection holds one slot of its product.
  - `plan.monthly_credits` (integer, required): Credits granted each billing period; 0 on the free plan.

## Errors

- `unauthorized` (401): The request carried no API key, or the key is invalid or disabled.

## Example

curl:

```bash
curl https://api.paxalabs.com/v1/me \
  -H "Authorization: Bearer $PAXA_API_KEY"
```

Response:

```json
{
  "key": {
    "id": "6b9f1a52-1b6e-4c9d-9f34-58a4c2f9d3aa",
    "name": "production",
    "key_start": "pxa_a3f2k9",
    "credit_limit": null,
    "credits_spent": 1240.39,
    "created_at": "2026-07-02T09:14:07.412Z",
    "last_used_at": "2026-08-03T05:41:52.108Z"
  },
  "balance": {
    "wallet": 8200,
    "plan": 14759.61,
    "total": 22959.61
  },
  "plan": {
    "key": "standard",
    "rpm": 200,
    "concurrency": 15,
    "monthly_credits": 25200
  }
}
```