Properties
| Name | Type | Description |
|---|---|---|
| entity | string | |
| platform | object | |
| canonical_url | object | |
| data_as_of | object | |
| schema_version | string | |
| common | object | |
| platform_fields | object | |
| freshness | object | |
| usage | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/veezee-io/json-schema/veezee-io-usage-envelope-schema.json",
"title": "usage_envelope",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/veezee-io-usage-api-openapi.yml#/components/schemas/usage_envelope",
"type": "object",
"properties": {
"entity": {
"type": "string",
"const": "usage"
},
"platform": {
"anyOf": [
{
"type": "string",
"enum": [
"linkedin",
"reddit",
"x"
]
},
{
"type": "null"
}
]
},
"canonical_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"data_as_of": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schema_version": {
"type": "string",
"const": "2"
},
"common": {
"type": "object",
"properties": {
"plan": {
"type": "string",
"enum": [
"trial",
"payg",
"flex",
"production"
]
},
"platforms": {
"type": "array",
"items": {
"type": "string"
},
"description": "Platforms this account's key may call. Grants are explicit; write to hello@veezee.io to enable more."
},
"balance_remaining": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"free_tier": {
"anyOf": [
{
"type": "object",
"properties": {
"credits_per_ip_day": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"used_today": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining_today": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"resets": {
"type": "string",
"description": "UTC midnight when the day budget resets. ISO 8601."
}
},
"required": [
"credits_per_ip_day",
"used_today",
"remaining_today",
"resets"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Present on trial keys: the shared per-IP day budget this key actually spends (balance_remaining stays 0 on the free tier; other callers on the same IP draw from the same pool). Null on paid plans."
},
"realtime_ops_used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"realtime_ops_limit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "Null means unlimited (paid plans)."
},
"concurrent_limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"recent_receipts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"receipt_id": {
"type": "string"
},
"tool": {
"type": "string"
},
"credits_charged": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"created_at": {
"type": "string"
}
},
"required": [
"receipt_id",
"tool",
"credits_charged",
"created_at"
],
"additionalProperties": false
},
"description": "Up to the last 10 charges."
},
"claim_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Present on trial accounts: open to attach an email so the account can be recovered if the key is lost."
},
"upgrade_url": {
"type": "string",
"description": "Give this link to your human to add credits or upgrade; purchases credit THIS account with no login."
},
"manage_url": {
"type": "string",
"description": "Give this link to your human to change or cancel a paid plan in the Stripe billing portal. Valid at least 24 hours; call get_usage again for a fresh one."
}
},
"required": [
"plan",
"platforms",
"balance_remaining",
"free_tier",
"realtime_ops_used",
"realtime_ops_limit",
"concurrent_limit",
"recent_receipts",
"claim_url",
"upgrade_url",
"manage_url"
],
"additionalProperties": false
},
"platform_fields": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"freshness": {
"anyOf": [
{
"type": "object",
"properties": {
"source_retrieved_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the data was fetched from the source. ISO 8601."
},
"served_at": {
"type": "string"
},
"cache_age_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"served_from_cache": {
"type": "boolean",
"description": "True when these bytes were served from cache rather than fetched for this call. source_retrieved_at says how old they are."
},
"freshness_requested": {
"type": "string",
"enum": [
"recent",
"realtime"
]
},
"freshness_served": {
"type": "string",
"enum": [
"recent",
"realtime",
"stale"
]
}
},
"required": [
"source_retrieved_at",
"served_at",
"cache_age_seconds",
"served_from_cache",
"freshness_requested",
"freshness_served"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"usage": {
"type": "object",
"properties": {
"receipt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"credits_quoted": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"credits_charged": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"balance_remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"free_tier_hint": {
"description": "Present on free-tier trial-key calls: what budget the call drew from and that paying upgrades this same key. Near the daily cap on unclaimed keys it also carries a claim link to relay to your human (claiming adds one-time credits).",
"type": "string"
}
},
"required": [
"receipt_id",
"credits_quoted",
"credits_charged",
"balance_remaining"
],
"additionalProperties": false
}
},
"required": [
"entity",
"platform",
"canonical_url",
"data_as_of",
"schema_version",
"common",
"platform_fields",
"freshness",
"usage"
],
"additionalProperties": false
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/veezee-io-usage-envelope"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.