---
title: "Get S3 Summary"
method: GET
path: "/api/v1/ledger/s3/summary"
tags: ["User APIs", "ledger-platform"]
---

# Get S3 Summary

`GET /api/v1/ledger/s3/summary`

The S3 wallet tiles and apply header.

Allocated / Accrued / Consumed / Available, plus reserved and remaining — what is
already applied to upcoming invoices and what is left after it.

## Response `200`

Successful Response

- S3BalanceSummaryResponse — Client-level S3 rollup plus its per-grant rows. ``available`` is the ledger balance (accrued − consumed) — the four wallet tiles. ``reserved`` and ``remaining`` are the apply header's extra two: tokens already applied to upcoming invoices, and what is left to apply after them. ``allocated`` sums the per-grant rows, each already net of its cancelled slices, so it is not the total ever awarded to this client.
  - `allocated` string, required
  - `accrued` string, required
  - `consumed` string, required
  - `available` string, required
  - `reserved` string, required
  - `remaining` string, required
  - `grants` S3GrantBalanceRow[], required
    - `grant_id` string, uuid, required
    - `client_id` string, uuid, nullable
    - `order_id` string, required
    - `award_date` string, date-time, nullable
    - `status` string, required
    - `vesting_kind` string, required
    - `block_contract_id` string, uuid, nullable
    - `block_request_id` string, uuid, nullable
    - `auto_apply` boolean
    - `allocated` string, required
    - `accrued` string, required
    - `consumed` string, required
    - `adjusted` string
    - `available` string, required
    - `periods_total` integer, required
    - `periods_issued` integer, required
    - `progress_pct` integer, required
    - `next_vest_at` string, date-time, nullable
    - `next_vest_amount` string, nullable

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)