Account summary

Account summary for the calling API key

Plan entitlements, quota consumption, monitoring usage and billing state for the account the key belongs to. Read-only and local: it never calls VIES, never contacts the payment provider and never spends quota, so an integration can poll it cheaply and use it as its connection test – an invalid or revoked key returns 401.

Test keys are accepted, so a customer can wire up an integration against the sandbox before switching to a live key.

Carries no personal data: an API key identifies an account, not a person.

get/v1/account

Request

  • Base URL: https://api.vatnode.dev
  • URL: https://api.vatnode.dev/v1/account
  • Auth: HTTP bearer

Response

Entitlements and consumption for the account.

Example response

{
  "key": {
    "label": "Production"
  },
  "plan": {
    "id": "starter",
    "name": "Starter",
    "monthlyQuota": 1000,
    "subscriptionsLimit": 25,
    "webhooksLimit": 3
  },
  "usage": {
    "used": 128,
    "limit": 1000,
    "remaining": 872
  },
  "monitoring": {
    "subscriptions": {
      "used": 4,
      "limit": 25
    },
    "webhooks": {
      "used": 4,
      "limit": 25
    }
  }
}

Changes

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