SendLimit

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-send-limit-schema.json",
  "title": "SendLimit",
  "description": "The account's sending limits, current usage and past volume requests.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/honkio-ca-openapi.json#/components/schemas/SendLimit",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "daily_limit",
    "sent_last_24h",
    "remaining",
    "window_hours",
    "approved_daily_limit",
    "probation_days",
    "recipient_rate_per_hour",
    "recipient_rate_per_day",
    "probation",
    "paused_until",
    "pause_reason",
    "toll_free",
    "number_queues",
    "requests"
  ],
  "properties": {
    "daily_limit": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Live sends from local numbers allowed in a rolling 24 hours. null when the account has no daily limit."
    },
    "sent_last_24h": {
      "type": "integer"
    },
    "remaining": {
      "type": [
        "integer",
        "null"
      ],
      "description": "null when the account has no daily limit."
    },
    "window_hours": {
      "type": "integer"
    },
    "approved_daily_limit": {
      "type": "integer",
      "description": "The standard volume a request is granted by default."
    },
    "probation_days": {
      "type": "integer"
    },
    "recipient_rate_per_hour": {
      "type": "integer",
      "description": "Messages one recipient may receive from the account in an hour."
    },
    "recipient_rate_per_day": {
      "type": "integer",
      "description": "Messages one recipient may receive from the account in a day."
    },
    "probation": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "started_at",
        "ends_at",
        "eligible_to_request"
      ],
      "properties": {
        "started_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "The first live send; null before it."
        },
        "ends_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "eligible_to_request": {
          "type": "boolean"
        }
      }
    },
    "paused_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Set while sending is paused."
    },
    "pause_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Why sending is paused: OPT_OUT_RATE, FAILURE_RATE or MANUAL."
    },
    "toll_free": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "daily_limit",
        "sent_last_24h",
        "remaining",
        "fanout_max_recipients",
        "broadcast_max_recipients",
        "broadcasts_per_day"
      ],
      "properties": {
        "daily_limit": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Live sends from toll-free numbers allowed in a rolling 24 hours. There is no probation. null when the account has no daily limit."
        },
        "sent_last_24h": {
          "type": "integer",
          "description": "Live sends from toll-free numbers in the last 24 hours."
        },
        "remaining": {
          "type": [
            "integer",
            "null"
          ],
          "description": "null when the account has no daily limit."
        },
        "fanout_max_recipients": {
          "type": "integer",
          "description": "Distinct recipients one identical body may reach from toll-free numbers in 24 hours."
        },
        "broadcast_max_recipients": {
          "type": "integer",
          "description": "Members a contact-group broadcast from a toll-free number may reach."
        },
        "broadcasts_per_day": {
          "type": "integer",
          "description": "Contact-group broadcasts from toll-free numbers per rolling 24 hours."
        }
      },
      "description": "The separate allowance for sends from toll-free numbers. Sends from local numbers count toward the top-level figures only."
    },
    "number_queues": {
      "type": "array",
      "description": "Each of your active numbers' carrier queue: the carrier sends a number's message parts at a fixed pace, so a list takes time. An estimate, from the parts already handed over.",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "required": [
          "phone_number",
          "parts_per_minute",
          "queued_parts",
          "clears_at"
        ],
        "properties": {
          "phone_number": {
            "type": "string"
          },
          "parts_per_minute": {
            "type": "integer",
            "description": "Message parts the carrier sends from this number a minute (10 for a local number)."
          },
          "queued_parts": {
            "type": "integer",
            "description": "Parts waiting now. A single send is refused with NUMBER_RATE_LIMITED while a minute's worth are waiting."
          },
          "clears_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the parts waiting now should all have gone out; null when none are waiting."
          }
        }
      }
    },
    "requests": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SendLimitRequest"
      }
    }
  },
  "$defs": {
    "SendLimitRequest": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "id",
        "requested_limit",
        "limit_at_request",
        "sent_last_30d_at_request",
        "reason",
        "status",
        "granted_limit",
        "staff_note",
        "decided_at",
        "created_at"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "requested_limit": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Messages per day asked for; null asks for the standard approved volume."
        },
        "limit_at_request": {
          "type": "integer"
        },
        "sent_last_30d_at_request": {
          "type": "integer"
        },
        "reason": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "PENDING",
            "APPROVED",
            "DENIED"
          ]
        },
        "granted_limit": {
          "type": [
            "integer",
            "null"
          ]
        },
        "staff_note": {
          "type": [
            "string",
            "null"
          ]
        },
        "decided_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "description": "A request for a higher daily sending volume."
    }
  }
}