---
title: "Get the credit balance"
method: GET
path: "/credits"
tags: ["Billing"]
---

# Get the credit balance

`GET /credits`

## Request

- Base URL: `https://api.tarifflo.com/api/v2`
- URL: `https://api.tarifflo.com/api/v2/credits`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The organization's balance, the current cycle's allowance and what each action consumed this cycle.

Any valid API key.

## Response `200`

Successful response

- object
  - `unit` 'token' | 'credit', required: Always "credit": every amount here is presented in credits, whatever the ledger counts in.
  - `balance` number, required
  - `reserved` number, required: Held by running work.
  - `used` number, required
  - `floor` number, required
  - `currentCycle` object, nullable, required
    - `start` string, required
    - `end` string, nullable, required
    - `allowance` number, required
    - `consumed` number, required
  - `perAction` object[], required
    - `action` string, required
    - `units` number, required
    - `credits` number, required

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `500`: Internal server error

---

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