---
title: "Retrieve current usage"
method: GET
path: "/parser/credits"
tags: ["Parsing API"]
---

# Retrieve current usage

`GET /parser/credits`

## Request

- Base URL: `https://contracko.com/api/v1`
- URL: `https://contracko.com/api/v1/parser/credits`
- Auth: one of:
  - API key in header `x-contracko-api-key`
  - HTTP bearer

Return current usage, remaining credits, and parser batch concurrency for the workspace.

## Response `200`

Current usage returned.

- object
  - `allocated` integer, required: Allocated credits in the current billing cycle
  - `used` integer, required: Consumed credits in the current billing cycle
  - `remaining` integer, required: Available credits for new parser work
  - `sourcePlanKey` string, required: Plan identifier associated with this usage window
  - `refreshesAt` string, date-time, nullable, required: ISO-8601 refresh timestamp for credits
  - `planName` string, required: Human-readable name of the current parsing plan
  - `maxConcurrency` integer, required: Maximum concurrent parser batches
  - `activeBatches` integer, required: Current number of active parser batches
  - `isInTrial` boolean, required: Whether the parser subscription is currently in trial

## Other responses

- `401`: Authentication failed (missing, invalid, revoked, or expired API key).
- `403`: Access denied because this API key does not include parsing access or the Parsing API is not available for this workspace.
- `429`: Retry later because the request rate limit was reached or too many parser batches are already running for this workspace.
- `500`: The server could not complete the request.

---

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