API reference · Usage

Get usage

GET/v1/usageFree

This month's operations, the allowance they count against, and when they reset.

Answer

200Your organization's

scope is organization: your plan's allowance, shared by all its workspaces. workspace appears when your organization set a monthly limit on this one. resetAt is the 1st of next month, UTC.

200A workspace's own

In an organization with several workspaces, a workspace whose people don't run the organization sees only its own usage and limit (allowance, or null without one), not the plan.

Errors

Every error has the same shape: see Errors.

Status	Code	When

See Limits and usage for what counts as an operation.

Request

curl "https://api.walletpassapi.com/v1/usage" \
  -H "Authorization: Bearer $WALLET_API_KEY"

const res = await fetch("https://api.walletpassapi.com/v1/usage", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
  },
});
const data = await res.json();

import os

import requests

res = requests.get(
    "https://api.walletpassapi.com/v1/usage",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/usage");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 Your organization's

{
  "plan": "starter",
  "scope": "organization",
  "used": 18342,
  "allowance": 100000,
  "resetAt": "2026-11-01T00:00:00.000Z"
}

200 A workspace's own

{
  "scope": "workspace",
  "used": 2210,
  "allowance": 10000,
  "resetAt": "2026-11-01T00:00:00.000Z"
}