---
title: "GET /api/v1/account"
method: GET
path: "/api/v1/account"
tags: ["Account"]
---

# GET /api/v1/account

`GET /api/v1/account`

## Request

- Base URL: `https://xquik.com`
- URL: `https://xquik.com/api/v1/account`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns plan, credit, monitoring, and account settings for the authenticated user.

## Response `200`

Account info

- object
  - `plan` 'active' | 'inactive', required
  - `subscription` object, required: Subscription state without billing provider identifiers.
    - `status` 'none' | 'active' | 'past_due' | 'canceling' | 'incomplete', required
    - `tier` 'starter' | 'pro' | 'business'
    - `currentPeriodStart` string, date-time
    - `currentPeriodEnd` string, date-time: Renewal date, or the end date when canceling.
  - `monitorsUsed` integer, required
  - `monitorsAllowed` integer, required: Deprecated. Monitor slots are unlimited, so this is always Number.MAX_SAFE_INTEGER.
  - `monitorBilling` object, required
    - `creditsPerActiveMonitorDay` '720', required: Daily credits charged for 1 active monitor.
    - `creditsPerActiveMonitorHour` '30', required: Hourly credits charged for 1 active monitor. It is a monitor's only charge.
    - `eventsIncluded` boolean, required: Monitor billing includes webhook and event deliveries.
    - `instantCheckIntervalSeconds` integer, required: Active monitors check every 1 second.
    - `unlimitedSlots` boolean, required: Monitor slot count is unlimited.
  - `creditInfo` object
    - `autoTopupEnabled` boolean, required
    - `autoTopupStopped` boolean, required: True when 3 declined charges in a row on 1 card stopped automatic top-up. The setting stays enabled. A paid top-up, a paid plan renewal, or the next automatic top-up on a new card clears it.
    - `autoTopupAmountDollars` number, required: Dollar amount charged when automatic top-up runs.
    - `autoTopupThreshold` '10000' | '50000' | '100000' | '250000', required: Bigint string threshold that triggers automatic top-up when enabled.
  - `xUsername` string: Linked X username, omitted when no X account is connected.

## Other responses

- `401`: Unauthenticated
- `429`: Too many requests right now. Each user gets 500 reads a second. Each minute allows 120 writes & 60 deletes. `x_api_rate_limited` means X limits this read for now. Neither answer costs anything. Wait for the seconds in `Retry-After`, then retry.
- `500`: Unexpected error.
- `4XX`: Client error. The error code says what to fix.
- `default`: Unexpected error.

## Changes

- **2026-10-20** `45942c75fdc2`: 10 warning
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `allOf[#/components/schemas/Error]/error/oneOf[subschema #2: StructuredError]/code` response property for the response status `429`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `401`
  - added the new `topup_in_progress` enum value to the `error/oneOf[subschema #1: LegacyErrorCode]/` response property for the response status `4XX`
  - …6 more

[Operation history](https://skmtc.dev/xquik-dev/apis/xquik-api/changes/api/v1/account/get.md)

---

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