---
title: "Get Client Balance"
method: GET
path: "/v2/clients/payments/balance-summary"
tags: ["Clients"]
---

# Get Client Balance

`GET /v2/clients/payments/balance-summary`

## Request

- Base URL: `https://api.carbonarc.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.carbonarc.co/v2/clients/payments/balance-summary`
- Auth: none declared

Get the balance of a client

## Request body

- object, nullable

## Response `200`

Successful Response

- ClientBalanceResponse
  - `total_balance` number, required
  - `promotional_balance` number, required
  - `purchased_balance` number, required
  - `expiry_schedule` ExpiryScheduleItem[], required
    - `amount` number, required
    - `expires_at` string, date-time, required
    - `token_type` string, required

## Other responses

- `404`: Not Found
- `422`: Validation Error

---

[API](https://skmtc.dev/carbonarc/apis/carbon-arc-api-documentation.md) · [All operations](https://skmtc.dev/carbonarc/apis/carbon-arc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonarc/apis/carbon-arc-api-documentation/revisions/7362ca3a398d?raw)