latestOpenAPI 3.1.02026-08-225721892.2 MB

19fd2b70854e

Usage

Account billing snapshot (plan, cycle, balance, caps, status)

The billing "wallet/statement" view: current plan, billing cycle, accrued balance + remaining credits this period, spend caps, and payment / access status. This is the billing half of the legacy /v1/usage-stats snapshot — the per-product consumption half is metering and lives on GET /v1/usage.

Usage-based (Metronome) accounts get a populated balance; legacy Stripe accounts get balance: null plus a deprecated legacy.limits block and, when payment-blocked, status.openInvoiceUrl / status.declineReason.

get/v1/billing

Response

Billing snapshot

billingSystem'metronome' | 'stripe' | 'shopify'
shopifyShopDomainstring nullable

myshopify.com domain owning the subscription; present only when billingSystem is shopify.