meta

Get this period's usage

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.

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

Response

Successful Response

periodstring required

yyyy-mm for live keys, yyyy-mm-dd for test keys.

pages_usedinteger required
pages_allowanceinteger required
overage_pagesinteger required

Recorded for information; never invoiced.

credit_pagesinteger required

Credit-pack pages left; spent before the allowance, never expire.

pages_remaininginteger required
modestring required

live or test.

Changes

No recorded changes to this operation across all 1 revision of this API.