Sign in
billing

Update auto-recharge settings

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.

put/billing/auto-recharge

Request body

$schemastring uri

A URL to the JSON Schema for this object.

enabledboolean required

Whether auto-recharge is active.

target_centsinteger required

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

threshold_centsinteger required

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

Example request

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

disabled_reason'payment_failed'

Why auto-recharge turned itself off (payment_failed), if it did. Re-enabling clears it.

enabledboolean required

Whether auto-recharge is active.

target_centsinteger required

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

threshold_centsinteger required

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

Example response

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

Changes