AXaxilioai
billing

Update auto-recharge settings

Changed on

Configures automatic balance top-up: when the balance drops below the threshold, a one-off invoice charges the saved payment method to restore it to the target. Requires an admin-role caller: an API key carries its creator's organization role, so the key must belong to an org admin. This only tunes when the saved payment method is charged — adding funds or payment methods stays in the dashboard.

patch/billing/auto-recharge

Request

Request body

$schemastring uri

A URL to the JSON Schema for this object.

enabledboolean

Whether auto-recharge is active. Enabling clears any prior payment-failure auto-disable.

target_microdollarsinteger

Balance the recharge restores to, in microdollars (minimum 5_000_000 = $5.00 while enabled).

threshold_microdollarsinteger

Recharge when the balance drops below this amount, in microdollars.

Example request

{
  "$schema": "/api/v1/SubscriptionAutoRechargeSettingsUpdate.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

disabled_reason'payment_failed' | 'disputed'

Why auto-recharge turned itself off, if it did: payment_failed (a recharge payment failed for good) or disputed (a payment was disputed). Re-enabling clears it.

enabledboolean required

Whether auto-recharge is active.

target_microdollarsinteger required

Balance the recharge restores to, in microdollars (minimum 5_000_000 = $5.00). The charge is target minus current balance.

threshold_microdollarsinteger required

Recharge when the balance drops below this amount, in microdollars.

Example response

{
  "$schema": "/api/v1/SubscriptionAutoRechargeSettingsResponse.json"
}

Changes