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.
Authorization
bearerAuth An API key from POST /v1/api-keys. Keys start with ref_.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/billing/wallet"{ "balanceCents": 0, "pendingCents": 0, "effectiveBalanceCents": 0, "burnPerDayCents": 0, "daysLeft": 0, "stopped": true, "lowBalance": true, "activeKeywords": 0, "autoMutedKeywords": 0, "nextDayCents": 0, "resumeCostCents": 0, "signupCredit": { "amountCents": 0, "grantedAt": "string" }, "lastTopUpAt": "string", "billingConfigured": true, "minTopUpCents": 0, "maxTopUpCents": 0, "defaultTopUpCents": 0, "currency": "USD", "autoRecharge": { "available": true, "enabled": true, "thresholdCents": 0, "amountCents": 0, "lastRunAt": "string", "lastError": "string" }}Get a receipt link
For a paid order from GET /v1/billing/invoices, returns a receipt PDF URL that expires soon.
List receipts
Returns the top-up orders, latest first, as Polar, the merchant of record, stores them. You get this workspace's orders among the billing customer's latest 100. No orders exist before the first top-up.