billing

Get auto-recharge settings.

Returns the tenant's opt-in auto-recharge settings. Requires the usage:read or machine:read scope.

get/v1/billing/auto-recharge

Request

Base URL
https://api.smolmachines.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/smolmachines/apis/smolfleet-api/docs/v1/billing/auto-recharge/get.ts
A function with typed inputs. Its response is checked against the schema.

Current opt-in auto-recharge settings (effective threshold/amount + whether a card is saved)

amountMicrosinteger required

Amount (micros) charged to the saved card each recharge.

enabledboolean required

Whether auto-recharge is enabled for this tenant.

hasSavedCardboolean required

Whether a card is saved on file (auto-recharge cannot fire without one).

setupUrlstring nullable

When enabling without a saved card, a Stripe-hosted URL to add one. Absent once a card is on file (or on plain reads).

thresholdMicrosinteger required

Balance (micros) at or below which a recharge fires.