---
title: "Retrieve credit usage for the current billing period"
method: GET
path: "/v1/credits/usage"
---

# Retrieve credit usage for the current billing period

`GET /v1/credits/usage`

## Request

- Base URL: `https://api.runbear.io`
- URL: `https://api.runbear.io/v1/credits/usage`
- Auth: HTTP bearer

Retrieve the organization's credit position for the current billing period: the credits included in the plan, the overage allowance and the overage consumed, and usage to date. The same numbers the Runbear billing page shows, for pulling into your own tracking.

## Response `200`

Default Response

- CreditUsage
  - `planIncludedCredits` number, nullable, required: Credits the plan includes each billing period, with an enterprise contract override taking precedence. `null` means unlimited.
  - `complimentaryCredits` number, required: Unexpired one-off credit grants on top of the plan. `0` when there are none.
  - `includedCredits` number, nullable, required: `planIncludedCredits + complimentaryCredits` — the base overage is measured from. `null` means unlimited.
  - `currentUsageCredits` number, required: Chargeable credits consumed so far in the current billing period.
  - `overageCreditsUsed` number, required: Chargeable credits consumed beyond `includedCredits` — usage past the included allowance, not the invoiced amount (the two can differ). Always `0` on an unlimited plan.
  - `overageLimitCredits` number, nullable, required: The overage allowance enabled for the organization. `null` when overage is off, which caps usage at `includedCredits`.
  - `periodStart` string, required: Start of the billing period the usage figures cover (ISO 8601).
  - `periodEnd` string, required: End of that period (ISO 8601), exclusive.

---

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