---
title: "Get authenticated customer's credit blocks"
method: GET
path: "/v1/account/credits"
tags: ["Account"]
---

# Get authenticated customer's credit blocks

`GET /v1/account/credits`

## Request

- Base URL: `https://api.platform.soax.com`
- URL: `https://api.platform.soax.com/v1/account/credits`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/soax/apis/soax-api/docs/v1/account/credits/get.ts> (a function with typed inputs; its response is checked against the schema)

List your active credit blocks with their initial and remaining balances and expiry dates. Credits are consumed by proxy traffic according to the tier of the country the traffic routes through.

Requires the `account:read` scope.

## Response `200`

Successful Response

- CreditBlockResponse[]
  - `id` string, required
  - `initial_balance` number, required
  - `balance` number, required
  - `effective_date` string, date-time, nullable
  - `expiry_date` string, date-time, nullable
  - `status` string, required

## Other responses

- `401`: Missing, invalid, or revoked API key.
- `403`: The API key does not carry the scope this endpoint requires.
- `429`: Rate limit exceeded (5 requests/second per API key, 500 requests/minute per IP). The response includes `Retry-After` (seconds), `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix time) headers — wait `Retry-After` seconds and retry.

---

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