Skip to content
Invogi Docs

Get lifetime or current-period usage and entitlement status

GET
/billing/usage
curl --request GET \
  --url https://api.invogi.com/v1/billing/usage \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Usage summary

Media typeapplication/json
object
plan_code
required
string
status
required
string
period_start
required
string | null format: date-time
period_end
required
string | null format: date-time
invoice_units_used
required
integer
invoice_units_included
required
integer | null
invoice_units_overage
required
integer
estimated_overage_eur
required
number | null
estimated_overage
required
number | null
currency_code
required
string
Allowed values: GBP EUR USD
additional_legal_entities
required
integer
document_pages_used
required
integer
document_pages_limit
required
integer | null
history_import_available
required

True while the workspace has rows left in its one-time 500-row invoice-history import

boolean
history_invoice_units_remaining
required

Rows left in the workspace’s one-time invoice-history import on any plan

integer
free_scan_available
required

True while a free workspace has invoice units left (kept for existing clients)

boolean
free_invoice_units_remaining
required

Free plan only - of the 500 invoice units in total

integer | null
external_processing_enabled
required
boolean

Example 

{
  "currency_code": "GBP"
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}