---
title: "Get credit balance"
method: GET
path: "/v2/credits/balance"
tags: ["Other"]
---

# Get credit balance

`GET /v2/credits/balance`

Get credit balance

## Query parameters

- `apiToken` string, nullable

## Headers

- `x-api-token` string, nullable

## Response `200`

Successful Response

- GetCreditBalanceResponse
  - `credits` Credits
    - `oneTime` number — Number of one-time credits left.
    - `recurrent` number — Number of recurrent credits left.
  - `emailCredits` Credits
    - `oneTime` number — Number of one-time credits left.
    - `recurrent` number — Number of recurrent credits left.
  - `phoneCredits` Credits
    - `oneTime` number — Number of one-time credits left.
    - `recurrent` number — Number of recurrent credits left.
  - `previewCredits` Credits
    - `oneTime` number — Number of one-time credits left.
    - `recurrent` number — Number of recurrent credits left.
  - `dailyLimitRateLeft` integer — Number of requests left for the current day.
  - `dailyLimitRateSecondsToReset` integer — Number of seconds left until the daily limit resets.

## Other responses

- `400` — Bad Request
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.dev/ocean/apis/ocean-io-api-documentation.md) · [All operations](https://skmtc.dev/ocean/apis/ocean-io-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ocean/ocean-io-api-documentation/revisions/505121e48722/schema)