Billing

Get the wallet

The prepaid balance in full: ledger, pending mention charges and the effective balance the stop rule reads, the daily burn and the days it buys, how many keywords run and how many the wallet paused, what a day costs and what a resume needs, the welcome credit, the newest top-up, the top-up bounds and the auto-recharge settings. GET /v1/usage is the short form.

get/v1/billing/wallet

Request

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

Response

Balance, burn, and whether tracking is paused

balanceCentsinteger required

Ledger balance: every credit minus every settled debit.

pendingCentsinteger required

Mentions and comments billed since the last daily settlement, priced but not yet debited.

effectiveBalanceCentsinteger required

balanceCents minus pendingCents: what the stop sweep and the keyword gate look at.

burnPerDayCentsinteger required

Average daily debit over the last 7 days (or since the workspace was created).

daysLeftinteger nullable required

effectiveBalanceCents divided by burnPerDayCents; null when nothing is burning.

stoppedboolean required

The wallet paused tracking; a top-up that covers a day of every keyword resumes it.

lowBalanceboolean required

Running, and the effective balance is at or under 20 percent of the last credit: the same rule as the low-balance email.

activeKeywordsinteger required

Unmuted keywords.

autoMutedKeywordsinteger required

Keywords the wallet paused; a top-up resumes them.

nextDayCentsinteger required

What one more day of the running keywords costs; tracking stops when the effective balance drops under it.

resumeCostCentsinteger required

What one day of every keyword (running and paused) costs; a stopped workspace resumes once the effective balance covers it.

lastTopUpAtstring nullable required

Newest paid top-up; null before the first.

billingConfiguredboolean required

False when this deployment has no Polar credentials: the top-up button is hidden.

minTopUpCentsinteger required

Smallest top-up the checkout accepts.

maxTopUpCentsinteger required

Largest single top-up.

defaultTopUpCentsinteger required

Amount prefilled in the checkout.

currency'USD' required

Every amount on this page is in USD cents.

Changes

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