---
title: "Get credit usage"
method: GET
path: "/usage"
tags: ["Usage"]
---

# Get credit usage

`GET /usage`

## Request

- Base URL: `https://api.gmaps.dev/v1`
- URL: `https://api.gmaps.dev/v1/usage`
- Auth: HTTP bearer

See this month's credits: what your plan includes, what you have used, what is left today and this month, and the same totals for each API key. Needs an API key. Costs no credits.

## Response `200`

Get credit usage

- object
  - `data` object, required
    - `plan` 'free' | 'starter' | 'pro' | 'scale' | 'internal', required: Your plan's id, such as free or pro.
    - `month` string, required: The month these numbers cover, in UTC, as YYYY-MM.
    - `creditsIncluded` integer, required: Credits your plan gives you this month.
    - `creditBalance` integer, required: Credits you bought and haven't used. They never expire.
    - `creditsRemaining` integer, required: Credits you can still spend: what is left of this month's plus the ones you bought.
    - `dailyCreditCap` integer, required: The most credits you can spend in one UTC day. Bought credits don't raise it.
    - `resetAt` string, date-time, required: When this month's credits start again: midnight UTC on the 1st.
    - `dailyResetAt` string, date-time, required: When today's limit starts again: the next midnight UTC.
    - `keys` object[], required: Usage per API key this month, including revoked keys and the console's own key: their usage is still yours.
      - `id` string, uuid, required: Our id for the key.
      - `name` string, required: The name you gave the key.
      - `prefix` string, required: The first characters of the key, for telling keys apart in a list.
      - `kind` 'api' | 'dashboard', required: `api` for a key you made, `dashboard` for the console's own.
      - `revoked` boolean, required: True once the key is revoked. Its usage still counts.
      - `creditsUsed` integer, required: Credits spent this month after refunds, bought ones included.
      - `balanceCreditsUsed` integer, required: The part of `creditsUsed` paid with bought credits, after refunds.
      - `dailyCreditsUsed` integer, required: Credits spent today, UTC.
      - `calls` integer, required: How many times credits were charged, not how many requests were made. A refund doesn't take one back.
    - `kinds` object[], required: This month's usage, split by what the credits paid for.
      - `kind` 'placeFresh' | 'emailFound', required: What the credits paid for: `placeFresh` for new places, `emailFound` for emails.
      - `creditsUsed` integer, required: Credits spent this month after refunds, bought ones included.
      - `balanceCreditsUsed` integer, required: The part of `creditsUsed` paid with bought credits, after refunds.
      - `dailyCreditsUsed` integer, required: Credits spent today, UTC.
      - `calls` integer, required: How many times credits were charged, not how many requests were made. A refund doesn't take one back.
    - `creditsUsed` integer, required: Credits spent this month after refunds, bought ones included.
    - `balanceCreditsUsed` integer, required: The part of `creditsUsed` paid with bought credits, after refunds.
    - `dailyCreditsUsed` integer, required: Credits spent today, UTC.
    - `calls` integer, required: How many times credits were charged, not how many requests were made. A refund doesn't take one back.
  - `meta` union
    - object
      - `total` integer, required: Every item that matches, not just this page.
      - `limit` integer, required: The most items a page holds.
      - `offset` integer, required: How many items came before this page.
      - `hasMore` boolean, required: True when another page follows.
    - object
      - `cost` integer, required: Credits this call took.
      - `creditsRemaining` integer, required: Credits left after this call, this month's and bought ones together.
      - `requestId` string, required: This call's id. Send it to support if something went wrong.
      - `cached` boolean: True when this response used only saved results.

## Other responses

- `default`: Any other failure.

---

[API](https://skmtc.dev/gmaps/apis/gmaps-dev.md) · [All operations](https://skmtc.dev/gmaps/apis/gmaps-dev/llms.txt) · [OpenAPI document](https://skmtc.dev/gmaps/apis/gmaps-dev/revisions/0b3459aaf802?raw)