putty
API ReferenceLedger

Read the caller's credit balance, tier, and next reset

Returns the two balances the caller's credits live in — `allowance` (the tier's monthly grant, spent first, never rolled over) and `purchased` (bought with money, never expires) — along with the tier their 7-day time-weighted $PUTTY holding resolves to, the tier above it, and when the allowance next resets. While the $PUTTY contract address is the zero address every caller is on `free`, whatever their snapshots say: there is no token to hold, so there is nothing to gate a tier on. `subsidyScalePercent` is below 100 when the global holder-subsidy cap is binding, which is why a holder's grant can be smaller than their tier's nominal allowance.

GET
/billing/account

Returns the two balances the caller's credits live in — allowance (the tier's monthly grant, spent first, never rolled over) and purchased (bought with money, never expires) — along with the tier their 7-day time-weighted $PUTTY holding resolves to, the tier above it, and when the allowance next resets.

While the $PUTTY contract address is the zero address every caller is on free, whatever their snapshots say: there is no token to hold, so there is nothing to gate a tier on. subsidyScalePercent is below 100 when the global holder-subsidy cap is binding, which is why a holder's grant can be smaller than their tier's nominal allowance.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/billing/account"
{  "account": {    "allowance": 0,    "purchased": 0,    "total": 0,    "tier": {      "slug": "string",      "name": "string",      "minHoldingUsd": "string",      "monthlyCredits": 0,      "sandboxes": 1,      "priorityQueue": true,      "launchKitsPerMonth": 0    },    "nextTier": {      "slug": "string",      "name": "string",      "minHoldingUsd": "string",      "monthlyCredits": 0,      "sandboxes": 1,      "priorityQueue": true,      "launchKitsPerMonth": 0    },    "holdingUsd7d": "string",    "daysUntilReset": 0,    "nextReset": "2019-08-24T14:15:22Z",    "subsidyScalePercent": 0  }}