GET/subscription/balance
Bearer authsubscriptionBalanceGet the current subscription status and transfer balance. This is also the PLAN response of the onboarding program: it carries the caller's regional price_tier, the welcome onboarding_ (null when none was issued) and the experiments assignments per surface. For a former subscriber it also carries the re-engagement program's comeback offer, winback_, while one is active.
Regional pricing rule (mmm/onboarding/PLAN.md): the tier is resolved, in order, from storefront_ (the store's storefront country, sent by the Apple and Google apps), the Stripe customer's billing country when a customer exists, else the client IP as a DISPLAY ESTIMATE (price_). The store charges its own storefront's price; the Stripe tier actually charged is finalized from the card's billing country once the payment method is attached, before the trial ends. The regional price is tied to the storefront/billing country, never to a VPN exit.
ISO 3166-1 alpha-2 (or alpha-3) storefront country of the app's store (StoreKit Storefront., Play billing region).
Responses1 status · show schema
The initial data balance in bytes for the period.
The current data balance in bytes.
Data tied up in pending contracts.
ONE of the active subscriptions, or absent. Shipped clients read this through the sdk and treat it as the plan indicator, so it keeps its single-value meaning and cannot name more than one store; use subscriptions for the full set.
udid
EVERY store currently billing this network, one entry per store, so a caller can offer a cancel path for each -- a user subscribed on two stores is charged by both and has to cancel in both places. Not gated on Pro: an active renewal row means a store is taking money now, which is exactly when the cancel path must be reachable.
udid
udid
udid
The balance carries revenue. Not the same as pro -- a data code is paid but data-only.
The balance carries the Pro entitlement. A network is Pro exactly when it has an in-window balance with this set.
The network has no login method (no email/phone, SSO, wallet or seedphrase sign-in): a legacy guest network. Read from the live auth methods on every call, so it stays true after a token refresh (which signs every jwt without the guest_mode claim) and turns false as soon as a login method is added with /auth/add-auth. A client must not sell a plan to a guest network: nothing can sign back in to it. Absent from older servers, where a client falls back to the jwt guest_mode claim.
always USD
how the country was resolved
true when the tier is a display estimate (ip or default)
The caller's welcome offer; null when none was issued.
When the offer was first redeemed; null until then.
The store of the first redemption; null until then.
The store of a purchase. A crypto purchase names its coin's market: solana for USDC and SOL, zcash, monero, bittensor for TAO, bitcoin and ethereum.
The caller's active win-back offer, from the re-engagement program's email to former subscribers. Absent when there is none, once it has expired or been redeemed, for a Stripe offer whose discounted first month would fall below Stripe's minimum charge at the caller's price tier (checkout would not apply it), and from older servers.
The discount, in percent.
The plan the offer discounts (monthly; no win-back offer is made on the yearly plan).
The one store the offer is redeemed on.
The Google Play offer's tag. Present only when store is play.
The App Store win-back offer's identifier. Present only when store is apple.
The caller's variant per experiment surface, keyed by surface (offer.in_app, email., offer., offer., offer.email, offer., email.<step>, cadence). Only running experiments appear. A network keeps its variant for the life of an experiment (hash(network_id, experiment_id), server-side). The variant holdout on offer.in_app means: show the regular plan picker, no offer screen, do not issue the offer in-app. Stamp the surface's experiment_id/variant on offer..
a registry variant name; holdout means show nothing
The coins the network can pay in now and what each sells, as /pay/crypto/assets lists them in assets: never a coin whose quotes the server refuses for now. Absent when there is none, and from older servers, so an older client never shows a crypto method and a newer one shows none then.
A coin a crypto invoice is paid in: usdc_solana (USDC on Solana), zec (Zcash, shielded), xmr (Monero), tao (TAO on Bittensor), btc (Bitcoin), eth (ETH on Ethereum mainnet) or sol (native SOL). TAO, Bitcoin, ETH and SOL are received into a Coinbase deposit address of each invoice's own and credited from the chain.
the chain to send on; absent from older servers
The chain a coin is paid on: solana (usdc_solana and sol), zcash, monero, bittensor (tao, the Finney network), bitcoin and ethereum (eth, Ethereum mainnet only). A coin sent on another network is not credited.
The decimals of the coin's atomic unit: amount_ is amount × 10^decimals (6 for USDC, 8 for Zcash and Bitcoin, 9 for TAO and SOL, 12 for Monero, 18 for ETH). Absent from older servers.
the most decimals a quoted amount has (8 for btc, 6 for every other coin); absent from older servers
Whether the coin's invoices carry a payment uri: false for tao, which has no payment link standard (the invoice gives the address and the amount, and uri_note says so). Absent from older servers.
the plans the asset sells (yearly, yearly_); never monthly
the data packs the asset sells (data_1tib, data_10tib); never data_256gib, which is sold only over x402 and with Gamma
the confirmations a payment needs before it is credited (for TAO, ETH and SOL, 1 is a finalized block)
how long a quote holds, in seconds
Whether the asset can be paid with now: true for every asset of assets and of crypto_, false for one of unavailable_ and crypto_. Absent from older servers, which listed only assets they would sell.
Why an asset that is on cannot be paid with now; absent when it can. scanner_: its scanner has not succeeded within three scan intervals (or never), or lags the network by more than the coin's allowed blocks. network_: the scanner knows no network height or wallet height, so the lag cannot be judged. not_: the coin is switched on but its backend is not configured (its chain source, or for TAO, Bitcoin, ETH and SOL the key that makes their deposit addresses). address_: no free receive address is ready. rates_: its rate sources were asked lately and left fewer than two fresh answers that agree. A UI shows any value as temporarily unavailable.
The coins that are on but cannot be paid with now, as /pay/crypto/assets lists them in unavailable_: each with available false and its unavailable_, for an app that shows a coin greyed out (the "More coins" tab while all four of its coins are unavailable). Never offered. Absent when there is none, and from older servers.
A coin a crypto invoice is paid in: usdc_solana (USDC on Solana), zec (Zcash, shielded), xmr (Monero), tao (TAO on Bittensor), btc (Bitcoin), eth (ETH on Ethereum mainnet) or sol (native SOL). TAO, Bitcoin, ETH and SOL are received into a Coinbase deposit address of each invoice's own and credited from the chain.
the chain to send on; absent from older servers
The chain a coin is paid on: solana (usdc_solana and sol), zcash, monero, bittensor (tao, the Finney network), bitcoin and ethereum (eth, Ethereum mainnet only). A coin sent on another network is not credited.
The decimals of the coin's atomic unit: amount_ is amount × 10^decimals (6 for USDC, 8 for Zcash and Bitcoin, 9 for TAO and SOL, 12 for Monero, 18 for ETH). Absent from older servers.
the most decimals a quoted amount has (8 for btc, 6 for every other coin); absent from older servers
Whether the coin's invoices carry a payment uri: false for tao, which has no payment link standard (the invoice gives the address and the amount, and uri_note says so). Absent from older servers.
the plans the asset sells (yearly, yearly_); never monthly
the data packs the asset sells (data_1tib, data_10tib); never data_256gib, which is sold only over x402 and with Gamma
the confirmations a payment needs before it is credited (for TAO, ETH and SOL, 1 is a finalized block)
how long a quote holds, in seconds
Whether the asset can be paid with now: true for every asset of assets and of crypto_, false for one of unavailable_ and crypto_. Absent from older servers, which listed only assets they would sell.
Why an asset that is on cannot be paid with now; absent when it can. scanner_: its scanner has not succeeded within three scan intervals (or never), or lags the network by more than the coin's allowed blocks. network_: the scanner knows no network height or wallet height, so the lag cannot be judged. not_: the coin is switched on but its backend is not configured (its chain source, or for TAO, Bitcoin, ETH and SOL the key that makes their deposit addresses). address_: no free receive address is ready. rates_: its rate sources were asked lately and left fewer than two fresh answers that agree. A UI shows any value as temporarily unavailable.
The network's latest one-time crypto credit (USDC or SOL on Solana, Zcash, Monero, TAO, Bitcoin or ETH) whose grace has not ended; absent when there is none.
The coin the term was paid with. USDC and native SOL share the solana market; asset tells them apart (usdc_solana or sol) for the whole term, after the payment's 30-day unlink too.
The subscription market of the credit: solana (USDC or SOL), monero, zcash, bittensor (TAO), bitcoin or ethereum (ETH).
when the paid term ends and the grace begins
when the grace ends, and Pro with it