get/v2/reports/usage

Metered usage for a month

Operation: getUsageReport
Authentication: API key

Billable and sandbox usage separately, plus the tenant’s ceilings — so a partner can see how close they are to a limit before they hit a 429 rather than after.

Request

Parameters

periodquerystring

Responses

200Usage for the period.

periodMonthstringrequired

linesobject[]required

totalBillableUnitsintegerrequired

totalTestUnitsintegerrequired

Sandbox traffic. Recorded so the graph is honest, never invoiced.

quotaobjectrequired

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/reports/usage \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Partner

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