Documents

PDF report allowance this month

This calendar month's PDF report allowance, how many are used and how many remain. source says which plan the allowance comes from: api (your API plan) or app (your web-app plan).

get/reports/usage

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/reports/usage
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Response

Allowance and use

allowanceinteger nullable
usedinteger
remaininginteger nullable
source'api' | 'app'

Changes

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