---
title: "Read your account, quota and active private offers"
method: GET
path: "/v1/me"
---

# Read your account, quota and active private offers

`GET /v1/me`

## Request

- Base URL: `https://api.pokemontcgapi.com`
- URL: `https://api.pokemontcgapi.com/v1/me`
- Auth: API key in header `X-Api-Key`

Requires account:read. On Free, plan.vision_trial reports the configured photo recognition calls, used calls and remaining calls; it is null on other plans. Private offers are applied automatically when starting a compatible checkout before their expiry. If multiple offers match, the most recently created one is used.

## Response `200`

Current account. The offers field is omitted when no unredeemed, unexpired offers exist.

- object
  - `data` object, required
    - `account` object
    - `plan` object
      - `vision_trial` object, nullable: Free trial recognition allowance; null on paid plans.
        - `calls` integer
        - `used` integer
        - `remaining` integer
    - `quota` object
    - `keys` object
    - `billing` object
    - `key` object
    - `verification` object
    - `upgrade_suggestion` Upgrade: Cheapest eligible purchasable monthly plan from the cached catalogue. Omitted when verification resolves the refusal or no safe higher plan is available. Existing subscribers change plan through manage_url.
      - `plan_code` string, required
      - `plan_name` string, required
      - `monthly_cents` integer, required
      - `currency` 'EUR', required
      - `reason` 'credits' | 'daily_cap' | 'card_allowance' | 'trial_expired' | 'vision' | 'movers' | 'graded_quotes' | 'all_locales' | 'history' | 'api_keys' | 'subscription_required', required
      - `checkout_url` string, uri: Site /subscribe link for starting a monthly subscription; omitted for existing subscribers.
      - `manage_url` string, uri: Use this account page and billing portal when a subscription already exists.
    - `usage_warnings` object[]
      - `code` 'NEAR_LIMIT', required
      - `resource` 'credits' | 'cards', required
      - `used` integer, required
      - `limit` integer, required
      - `stale` boolean, required
      - `message` string, required
    - `offers` object[]: Open private offers, newest first. Absent when there are none.
      - `plan` string, nullable, required: Eligible plan code; null means any purchasable plan.
      - `interval` 'MONTHLY' | 'YEARLY' | 'null', nullable, required: Eligible billing interval; null means either.
      - `coupon` string, required: Stripe coupon applied automatically by checkout.
      - `expires_at` string, date-time, required: Deadline to start a discounted checkout, in RFC3339.

## Other responses

- `401`: Authentication required.
- `403`: The key does not have account:read scope.

---

[API](https://skmtc.dev/pokemontcgapi/apis/pokemon-tcg-api.md) · [All operations](https://skmtc.dev/pokemontcgapi/apis/pokemon-tcg-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pokemontcgapi/apis/pokemon-tcg-api/revisions/9e4ee9a375da?raw)