Arm auto top-up (buy item_id off-session when the balance falls below threshold_credits; it spends within the account's agent period limit) or turn it off; audited; counts toward 30 billing-settings changes per hour

put/v1/account/billing/auto-topup

Request

  • Base URL: https://api.roveapi.com
  • URL: https://api.roveapi.com/v1/account/billing/auto-topup
  • Auth: API key in cookie rove_session

Request body

state'off' | 'armed' required
threshold_creditsinteger

Required to arm: buy when the balance falls below this many whole credits. Ignored when state is off.

item_idstring

Required to arm: a current catalogue pack whose price is within the per-purchase limit. Ignored when state is off.

Response

Successful response (Cache-Control: no-store)

state'off' | 'armed' | 'in_flight' | 'paused' required

off until the owner arms it; in_flight while its purchase is being paid; paused until the owner arms it again (or its handoff is paid).

threshold_creditsinteger nullable required

Buys when the balance falls below this many whole credits; null until first configured.

item_idstring nullable required

The catalogue pack it buys; null until first configured.

blocked_untilstring date-time nullable required

Set when the account's agent period limit refused it: it waits until then (the period end).

pause_reason'no_saved_method' | 'off_session_not_allowed' | 'purchasing_off' | 'item_retired' | 'exceeds_per_purchase_limit' | 'authentication_required' | 'card_declined' | 'stripe_request_unconfirmed' nullable required
in_flight_purchase_idstring uuid nullable required

The purchase it follows: the one in flight, or the handoff a paused (authentication_required) one waits on; read it at /v1/account/billing/purchases/{id} for the payment link.

Changes

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