BalanceResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/difficat-com/json-schema/difficat-com-balance-response-schema.json",
  "title": "BalanceResponse",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/difficat-com-openapi.yml#/components/schemas/BalanceResponse",
  "type": "object",
  "required": [
    "keyId",
    "balance",
    "currency",
    "recent"
  ],
  "properties": {
    "keyId": {
      "type": "string"
    },
    "balance": {
      "type": "string",
      "description": "Spendable prepaid money, decimal USD, for any key."
    },
    "currency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "allowance": {
      "type": "object",
      "description": "Pro account’s key only: the current period’s included captured pages, shared with the web app; a live pair is 2, a pair against a snapshot 1.",
      "required": [
        "includedPages",
        "pagesUsed",
        "resetsAt"
      ],
      "properties": {
        "includedPages": {
          "type": "integer"
        },
        "pagesUsed": {
          "type": "integer"
        },
        "resetsAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "overage": {
      "type": "object",
      "description": "Pro account’s key only: overage priced this period and the cap, decimal USD.",
      "required": [
        "amount",
        "capUsd"
      ],
      "properties": {
        "amount": {
          "type": "string"
        },
        "capUsd": {
          "type": "string"
        }
      }
    },
    "recent": {
      "type": "array",
      "description": "The last 20 ledger entries, newest first.",
      "items": {
        "type": "object",
        "required": [
          "at",
          "type",
          "amount"
        ],
        "properties": {
          "at": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "enum": [
              "topup",
              "debit",
              "reversal",
              "overage",
              "return"
            ]
          },
          "amount": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "discover",
              "screenshot",
              "job"
            ]
          },
          "jobId": {
            "type": "string"
          },
          "surface": {
            "type": "string",
            "enum": [
              "web",
              "api"
            ],
            "description": "An account key’s draw: spent in the web app or on the API."
          }
        }
      }
    }
  }
}