AXaxilioai
billing

Get auto-recharge settings

Changed on

Returns the organization's automatic balance top-up configuration and status.

get/billing/auto-recharge

Request

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

  • 49b1da5a7974Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new disputed enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • e2261ff54e62Revision changes
    • info

      the endpoint scheme security bearerAuth was removed from the API