---
title: "Credits"
method: GET
path: "/v1/credits"
tags: ["account"]
---

# Credits

`GET /v1/credits`

## Request

- Base URL: `https://api.insightsocial.app`
- URL: `https://api.insightsocial.app/v1/credits`
- Auth: API key in header `x-api-key`

The calling key owner's balance and this period's usage. Free.

## Response `200`

Success.

- object
  - `success` true
  - `credits_used` integer
  - `credits_remaining` integer
  - `plan` object
    - `tier` 'free' | 'pro'
    - `credits_per_month` integer
    - `resets_at` string, date-time
  - `usage` object
    - `window_start` string, date-time
    - `used` integer
    - `used_export` integer
    - `used_api` integer
  - `pack_credits` integer: Purchased pack credits. They never expire.
  - `free_calls` object
    - `remaining` integer
    - `total` integer
  - `key` object
    - `id` string, uuid
    - `name` string
  - `request_id` string

## Other responses

- `401`: See [Error handling](https://www.insightsocial.app/docs/errors).

---

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