Account: key and usage

Does not count as a call. Shows the calendar month’s usage against the allowance, the credit balance and its earliest expiry, and the plan status.

About the account view

The month is the UTC calendar month. usage.remaining counts the allowance only; credits.remaining is separate and is consumed after the allowance.

GET/me

Your key, tier, usage and credits

Does not count as a call. Shows the calendar month’s usage against the allowance, the credit balance and its earliest expiry, and the plan status.

Tiers
freecreditsplan
Cost
0

Request

curl
curl -H "Authorization: Bearer vp_live_YOUR_KEY" "https://veriport.io/api/v1/me"

Response 200

The account view.

FieldTypeDescription
keyPrefixstring
tier"free" | "credits" | "plan"
createdAtstring (date-time)
monthstring
usageobject
usage.callsinteger
usage.allowanceinteger
usage.remaininginteger
usage.byEndpointobject
creditsobject
credits.remaininginteger
credits.earliestExpirystring | null (date)
planobject | null
plan.statusstring
plan.currentPeriodEndstring | null (date-time)
limitsobject
limits.rpsinteger
limits.bulkboolean
limits.consultationNumberboolean
200 OK · application/json
{
  "keyPrefix": "vp_live_3f9a",
  "tier": "free",
  "createdAt": "2026-10-24T09:00:00Z",
  "month": "2026-10",
  "usage": {
    "calls": 12,
    "allowance": 100,
    "remaining": 88,
    "byEndpoint": {
      "vat/validate": 9,
      "iban/validate": 3
    }
  },
  "credits": {
    "remaining": 0,
    "earliestExpiry": null
  },
  "plan": null,
  "limits": {
    "rps": 2,
    "bulk": false,
    "consultationNumber": false
  }
}

Errors

  • 401unauthorized — The API key is missing, unknown or revoked.