billing

Update auto-recharge settings.

Changed on

Updates opt-in auto-recharge; enabling with no saved card returns a setup URL. Requires the billing:write scope.

post/v1/billing/auto-recharge

Request

Request body

amountMicrosinteger nullable

Top-up amount in micros (null → fleet default). Must be ≥ $1 and > threshold.

enabledboolean required

Master switch. Disabling never charges; enabling requires a saved card (the response returns a setupUrl to add one when none is on file yet).

thresholdMicrosinteger nullable

Trigger threshold in micros (null → fleet default). Must be < amount.

Response

Updated auto-recharge settings. When enabling with no card on file, the response carries a setupUrl to add one.

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.

Changes