Skip to main content
GET
Xquik account details & subscription status
Free. This endpoint does not consume credits.

Run an API account preflight

Call GET /account before a long tweet search, follower export, scheduled write, or monitor rollout. The response separates subscription access, available credits, active monitor cost, automatic top-up settings, and the linked X username. Use plan to report subscription state. Do not use it to decide whether credits remain. Funded pay-as-you-go requests can continue while plan is inactive. Treat missing creditInfo as no recorded balance, not numeric zero. Do not use monitorsAllowed as a capacity limit. The field is deprecated and always reports the maximum safe integer. Use monitorsUsed and the monitor billing fields for cost checks.

Store an account billing snapshot

Store a timestamped account snapshot before a worker starts billable work. Never convert credit strings to an unsafe JavaScript number.

Headers

string
required
Your API key. Generate one from the API Keys page.

Response

200 OK

string
Subscription status. "active" or "inactive".
object
Subscription state, without billing provider IDs. Subscription object fields.
string
none, active, past_due, canceling or incomplete.
string
starter, pro or business. Omitted without a subscription.
string
Start of the current billing period, ISO 8601.
string
Renewal date, or the end date when canceling. ISO 8601.
number
Deprecated. Monitor slots are unlimited, so this is always 9007199254740991.
number
Number of active account monitors and keyword monitors.
object
Active monitor billing details. Monitor billing object fields.
string
Estimated daily credits for active monitors.
string
Credits charged each hour for active monitors.
string
Rounded daily credit estimate for 1 active monitor.
string
Hourly credits charged for 1 active monitor.
boolean
Whether monitor billing includes webhook and event deliveries.
number
Active monitor check interval in seconds.
boolean
Whether monitor slot count is unlimited.
object
Credit balance details. Omitted if no credit balance row exists yet. Credit info object fields.
string
Current credit balance (Bigint string to preserve precision above Number.MAX_SAFE_INTEGER).
string
Total credits purchased across all time (Bigint string).
string
Total credits consumed across all time (Bigint string).
boolean
Whether automatic credit top-up is enabled.
boolean
Whether declined charges stopped automatic top-up while it is enabled. It stops after 3 declines in a row on one card. A paid top-up, a paid plan renewal, or the next automatic top-up on a new card clears it.
number
Dollar amount charged when automatic top-up runs.
string
Credit balance threshold that triggers automatic top-up when enabled (Bigint string).
string
Linked X username. Omitted when no X account is connected.

401 Unauthenticated

Missing or invalid API key. Check the x-api-key header value.

429 Rate limited

Too many requests. Wait for the Retry-After header before retrying.

Credit balance

Every subscriber gets a monthly credit allowance. Metered reads bill per result or call. Writes bill per action. Active monitors bill 21 credits per hour. monitorsUsed, monitorBilling.activeHourlyBurn, and monitorBilling.activeDailyEstimate include active account monitors and active keyword monitors. Xquik rounds the daily estimate. At 0 credits, metered calls return 402.