> ## Documentation Index
> Fetch the complete documentation index at: https://www.mapsdata.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get account

> Read the current plan, subscription status, search allowance, and remaining credits.

Call this endpoint before creating a search. It returns the account-wide values that determine whether a request can be accepted.

<RequestExample>
  ```bash cURL theme={null}
  curl "https://www.mapsdata.io/api/v1/account" \
    -H "x-api-key: md_live_your_key"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "plan_code": "starter",
    "plan_name": "Starter",
    "status": "active",
    "billing_interval": "monthly",
    "credits_allowance": 10000,
    "credits_remaining": 7420,
    "max_results_per_search": 700,
    "free_search_used": false,
    "stripe_customer": true,
    "current_period_end": "2026-10-31T23:59:59Z",
    "cancel_at_period_end": false,
    "pause_collection": false,
    "pause_resumes_at": null,
    "cancellation_coupon_applied": false,
    "searches_created": 18,
    "active_searches": 1,
    "leads_found": 2480
  }
  ```
</ResponseExample>

## Response fields

<ResponseField name="plan_code" type="string">Machine-readable plan: `free`, `starter`, `growth`, or `scale`.</ResponseField>
<ResponseField name="status" type="string">Subscription status. Paid searches require `active` or `trialing`.</ResponseField>
<ResponseField name="credits_allowance" type="integer">Credits assigned to the current plan period.</ResponseField>
<ResponseField name="credits_remaining" type="integer">Credits available for new searches.</ResponseField>
<ResponseField name="max_results_per_search" type="integer">Current account ceiling: `100` on free, `700` on an active paid plan, and `0` when a paid subscription is inactive.</ResponseField>
<ResponseField name="free_search_used" type="boolean">Whether the account already used its one free search.</ResponseField>
<ResponseField name="active_searches" type="integer">Jobs currently queued or processing.</ResponseField>
<ResponseField name="leads_found" type="integer">Businesses imported across dashboard and API searches.</ResponseField>

<div className="callout mint-my-5 mint-rounded-xl mint-border mint-border-[#656c2e]/30 mint-bg-[#656c2e]/10 mint-px-5 mint-py-4 mint-text-sm mint-text-[#4d5321]">
  Use <code>Math.min(max\_results\_per\_search, credits\_remaining)</code> as the largest affordable <code>maxResults</code>. A free account is still limited by whether its free search was already used.
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.