---
title: "Credit balance and ledger"
method: GET
path: "/api/v1/credits"
tags: ["credits"]
---

# Credit balance and ledger

`GET /api/v1/credits`

## Request

- Base URL: `https://singlefax.com`
- URL: `https://singlefax.com/api/v1/credits`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.singlefax.com/api/auth/oauth2/authorize`, token URL `https://api.singlefax.com/api/auth/oauth2/token`, scopes: `credits:read`)

## Response `200`

Balance

- CreditBalance
  - `availableCents` integer, required
  - `reservedCents` integer, required
  - `ledger` object[]

## Other responses

- `401`: Missing or invalid credentials
- `403`: Missing credits:read scope

---

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