AutoRechargeResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/audivo-dev/json-schema/audivo-dev-auto-recharge-response-schema.json",
  "title": "AutoRechargeResponse",
  "description": "Whether this account tops itself up, and the figures it would use. Every figure is `null` when `available` is false, which is the free tier: its grant is one-time and it has no price to charge.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/audivo-dev-openapi.yaml#/components/schemas/AutoRechargeResponse",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "available",
    "enabled",
    "threshold_credits",
    "top_up_credits",
    "top_up_amount_cents",
    "currency",
    "failure"
  ],
  "properties": {
    "available": {
      "type": "boolean",
      "description": "Whether this account's tier can auto-recharge at all."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the customer has switched it on."
    },
    "threshold_credits": {
      "anyOf": [
        {
          "$ref": "#/$defs/CreditAmount"
        },
        {
          "enum": [
            null
          ]
        }
      ],
      "description": "The settled balance at which a top-up is triggered — a floor crossed downward, not a total spent. It is a tenth of the tier's included allowance."
    },
    "top_up_credits": {
      "anyOf": [
        {
          "$ref": "#/$defs/CreditAmount"
        },
        {
          "enum": [
            null
          ]
        }
      ],
      "description": "The credits a top-up adds — one more month of the tier's allowance."
    },
    "top_up_amount_cents": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "enum": [
            null
          ]
        }
      ],
      "description": "What a top-up costs, in the currency's smallest unit."
    },
    "currency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "enum": [
            null
          ]
        }
      ],
      "description": "ISO 4217 code for `top_up_amount_cents`."
    },
    "failure": {
      "description": "The last decline, or `null`. A recorded failure pauses auto-recharge; switching it on again clears this.",
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "code",
            "at"
          ],
          "properties": {
            "code": {
              "type": "string",
              "description": "The provider's decline code, and nothing beside it — the message Stripe pairs with it quotes the card."
            },
            "at": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date-time"
                },
                {
                  "enum": [
                    null
                  ]
                }
              ]
            }
          }
        },
        {
          "enum": [
            null
          ]
        }
      ]
    }
  },
  "$defs": {
    "CreditAmount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "A non-negative JavaScript-safe integer credit amount. The upper bound matches `Number.MAX_SAFE_INTEGER`, which is enforced by the domain ledger so arithmetic and JSON round-trips cannot silently lose cents worth of credit precision."
    }
  }
}