Billing

Get the balance

Returns every detail of the prepaid balance. That covers the ledger total, pending mention charges, the effective balance used for pausing, the daily spend and days left, running and paused keywords, the cost of a day and of resuming, the welcome credit, the latest top-up, the top-up limits and the auto-recharge settings. GET /v1/usage gives a shorter version.

get/v1/billing/wallet

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/billing/wallet
  • Auth: HTTP bearer

Response

Wallet balance, daily spend and pause state

balanceCentsinteger required

The ledger balance, all credits minus all settled debits.

pendingCentsinteger required

Cost of mentions matched after the last daily settlement. Not debited yet.

effectiveBalanceCentsinteger required

balanceCents minus pendingCents. Pausing at zero and the check before adding keywords both use this number.

burnPerDayCentsinteger required

Mean daily debit across the past 7 days, or the workspace's lifetime if shorter.

daysLeftinteger nullable required

effectiveBalanceCents over burnPerDayCents, rounded down. Null when burnPerDayCents is 0.

stoppedboolean required

True when tracking is paused because the balance ran out. It resumes after a top-up that covers one day of every keyword.

lowBalanceboolean required

True when tracking is running and the effective balance is 20 percent of the last credit or less. The low-balance email uses the same rule.

activeKeywordsinteger required

Keywords that are not muted.

autoMutedKeywordsinteger required

Keywords muted for low balance. A top-up restarts them.

nextDayCentsinteger required

Next day's cost for the running keywords. Tracking stops if the effective balance drops below it.

resumeCostCentsinteger required

Daily cost of every keyword, running or paused. Tracking restarts once the effective balance reaches this amount.

lastTopUpAtstring nullable required

Latest paid top-up time, or null if there is none.

billingConfiguredboolean required

Whether top-ups work here. false when Polar isn't configured, which hides the top-up button.

minTopUpCentsinteger required

The minimum top-up at checkout.

maxTopUpCentsinteger required

The maximum for one top-up.

defaultTopUpCentsinteger required

The amount the checkout starts with.

currency'USD' required

All amounts here are in US cents.

Changes

No recorded changes to this operation across all 1 revision of this API.