---
title: "Credits usage"
method: GET
path: "/credits/usage"
tags: ["credits", "usage"]
---

# Credits usage

`GET /credits/usage`

Returns the current credits usage with some details to help you know where your usage is at.

It contains the `total` credits, the `remaining` credits you can use for your period and the `used` number of credits.

The `base` value might differ from the `total` if you have enabled overage. In this case, `base` represent the default limit from your current plan, whereas `total` is the limit set in your overage. Once your credit usage reaches the `total`, the conversions will be refused.

## Response `200`

Current credit usage

- Credits
  - `credits` object
    - `base` integer
    - `remaining` integer
    - `total` integer
    - `used` integer
  - `success` boolean

## Other responses

- `401` — Unauthorized. Invalid auth key, missing, or disabled.
- `429` — Too Many Requests. You have been rate limited.
- `500` — Internal Server Error.

---

[API](https://skmtc.dev/pdfshift/apis/pdfshift-api-documentation.md) · [All operations](https://skmtc.dev/pdfshift/apis/pdfshift-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pdfshift/pdfshift-api-documentation/revisions/0b8cbae61b89/schema)
