---
title: "Retrieve public API credit usage"
method: GET
path: "/v1/credits"
tags: ["v1"]
---

# Retrieve public API credit usage

`GET /v1/credits`

## Response `200`

Successful credit usage lookup

- CreditsUsage
  - `used_credits` integer, required
  - `included_credits` integer, required
  - `remaining_credits` integer, required — Never negative; zero once usage exceeds included credits.
  - `overage_credits` integer, required — Credits above the included allowance.
  - `paid` boolean, required
  - `period` CreditsUsagePeriod, required
    - `type` 'billing_cycle' | 'rolling_30_days', required — billing_cycle for paid plans; rolling_30_days for the free plan, where the window starts with the first request.
    - `reset_at` string, date-time, required

## Other responses

- `401` — Unauthorized - Authentication required
- `500` — Internal Server Error - An error occurred while processing the request

---

[API](https://skmtc.net/oregister/apis/openregister-api.md) · [All operations](https://skmtc.net/oregister/apis/openregister-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oregister/openregister-api/versions/d1fcaf6d6ca0/schema)