Won · usage

このキーが使った額と、残っている額

usage は「続けてよいか」に答えます。このキー自身の累計コスト、属するワークスペースの期間内コスト、その期間における各ストアのコスト、そして次の呼び出しを左右するプリペイド残高を返します。

件数

呼び出しは 1 つです。days はワークスペースとストアの数値の期間を決めます。キー自身の数値は累計なので、この値では動きません。

u = mem.usage(days=7)
# {"window_days": 7, "key": {"requests": 26, "cost_cents": 1.19, …}, …}

if u["balance_cents"] <= 0:
    # top up before the next write
const u = await mem.usage(7);

if (u.balance_cents <= 0) {
  // top up before the next write
}
let u = mem.usage(7).await?;
let left = u["balance_cents"].as_f64().unwrap_or(0.0);
curl https://api.wontopos.com/api/v1/won/usage?days=7 \
  -H "X-API-Key: $WOS_KEY"
フィールド意味
keyこのキーだけです。アカウントの他のキーの一覧は返しません。since は常に "lifetime" です。
workspaceこのキーが属するワークスペースの、指定した期間の値です。
stores期間内のストア別コスト。使用量の多い順、最大 50 行です。other は 1 日に 200 を超えるストアを計測したときの残りをまとめた枠で、実在するストアではありません。
balance_centsアカウントに残っているプリペイド残高。マイナスは超過です。
expiring_soon_cents残高のうち、90 日以内に失効する額です。
daysワークスペースとストアの数値の期間。1〜365、既定は 7。範囲外は拒否せず丸めます。

Won の呼び出しと同じく無料です。トークン料金もリクエスト料金もなく、残高ゲートも通しません。残高 0 のアカウントでも理由を知れるべきだからです。このエンドポイントは毎分 10 回、アカウントの Won 呼び出し全体で毎時 300 回を共有します。