---
title: "Get this period's usage"
method: GET
path: "/v1/usage"
tags: ["meta"]
---

# Get this period's usage

`GET /v1/usage`

## Request

- Base URL: `https://api.niubai.vip` (the document declares no server; this is the origin it was published from)
- URL: `https://api.niubai.vip/v1/usage`
- Auth: HTTP bearer

Pages used, the allowance, credit-pack pages and what remains for the current period of the calling key's account. The same numbers the account page shows.

## Response `200`

Successful Response

- AccountUsageOut
  - `period` string, required: `yyyy-mm` for live keys, `yyyy-mm-dd` for test keys.
  - `pages_used` integer, required
  - `pages_allowance` integer, required
  - `overage_pages` integer, required: Recorded for information; never invoiced.
  - `credit_pages` integer, required: Credit-pack pages left; spent before the allowance, never expire.
  - `pages_remaining` integer, required
  - `mode` string, required: `live` or `test`.

## Other responses

- `401`: error.code is one of: unauthorized
- `429`: error.code is one of: rate_limited

---

[API](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway.md) · [All operations](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/niubai/apis/pdf-edit-api-gateway/revisions/1ad0ce16ca04?raw)