API reference / Billing

get/v2/invoices/{period}

One month’s statement

Operation
getStatement
Authentication
API key

Computed from `usage_events` and `payments` rather than stored, so every figure can be traced to the rows behind it. Sandbox calls are excluded. Revenue share is paid on our service fee only — the government fee is not ours to share.

Request

Parameters

periodpathrequiredstring

Responses

200The statement.
periodstringrequired
tenantobjectrequired
currencystringrequired
linesobject[]required
subtotal_centsintegerrequired
total_centsintegerrequired
negotiatedbooleanrequired

True when the plan has no published rate card. The totals are zero rather than invented, and a client should show “contact us” instead of a number.

notestringrequired
400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403The key is valid but lacks the scope, or it asked for a scope it does not itself hold.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X GET https://api.haavisa.com/v2/invoices/<period> \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Billing

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.