{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/linkbreakers-com/json-schema/linkbreakers-com-list-allowances-response-schema.json",
  "title": "The workspace's allowances",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/linkbreakers-com-allowances-api-openapi.yml#/components/schemas/ListAllowancesResponse",
  "properties": {
    "allowances": {
      "items": {
        "$ref": "#/$defs/WorkspaceAllowance",
        "type": "object"
      },
      "title": "One entry per limit the plan sets",
      "type": "array"
    },
    "limits": {
      "description": "Every limit this workspace is allowed, as enforced for its subscription, including the ones not counted per cycle such as webhooks and the Assistant rate. A trial or sponsored workspace can be allowed less than the plan it reports, and these are what it gets.",
      "items": {
        "$ref": "#/$defs/PlanLimit",
        "type": "object"
      },
      "type": "array"
    },
    "plan": {
      "$ref": "#/$defs/PricingPlanId",
      "description": "The plan the limits come from. A trial or sponsored workspace reports the plan it is allowed what of."
    }
  },
  "type": "object",
  "$defs": {
    "PlanLimit": {
      "properties": {
        "key": {
          "description": "- PLAN_LIMIT_KEY_UNSPECIFIED: Not set\n - PLAN_LIMIT_KEY_CUSTOM_DOMAINS: Custom domains connected to the workspace\n - PLAN_LIMIT_KEY_TEAM_MEMBERS: Members of the workspace\n - PLAN_LIMIT_KEY_PLATFORM_CREDITS: Platform credits, spent by creating links and by AI features\n - PLAN_LIMIT_KEY_TRACKED_VISITS: Tracked visits (scans and clicks)\n - PLAN_LIMIT_KEY_PUBLIC_API_CALLS: Public API calls\n - PLAN_LIMIT_KEY_WEBHOOKS: Webhooks configured in the workspace\n - PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE: Assistant messages per minute\n - PLAN_LIMIT_KEY_LINKS_INCLUDED: Links the monthly platform credits pay for. Links are not capped on their own: each one spends credits.\n - PLAN_LIMIT_KEY_MEDIA_STORAGE_MB: Megabytes of uploaded media (media for Open media steps, QR code logos, page theme images) the workspace may hold at once. A standing total: deleting media frees it.",
          "enum": [
            "PLAN_LIMIT_KEY_UNSPECIFIED",
            "PLAN_LIMIT_KEY_CUSTOM_DOMAINS",
            "PLAN_LIMIT_KEY_TEAM_MEMBERS",
            "PLAN_LIMIT_KEY_PLATFORM_CREDITS",
            "PLAN_LIMIT_KEY_TRACKED_VISITS",
            "PLAN_LIMIT_KEY_PUBLIC_API_CALLS",
            "PLAN_LIMIT_KEY_WEBHOOKS",
            "PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE",
            "PLAN_LIMIT_KEY_LINKS_INCLUDED",
            "PLAN_LIMIT_KEY_MEDIA_STORAGE_MB"
          ],
          "title": "What the limit is on"
        },
        "kind": {
          "description": "- PLAN_LIMIT_KIND_UNSPECIFIED: Not set\n - PLAN_LIMIT_KIND_TOTAL: A standing total that does not refill, such as connected domains\n - PLAN_LIMIT_KIND_MONTHLY: An allowance that refills every month\n - PLAN_LIMIT_KIND_PER_MINUTE: A rate that refills every minute\n - PLAN_LIMIT_KIND_UNLIMITED: No ceiling\n - PLAN_LIMIT_KIND_METERED: No ceiling; every unit is billed",
          "enum": [
            "PLAN_LIMIT_KIND_UNSPECIFIED",
            "PLAN_LIMIT_KIND_TOTAL",
            "PLAN_LIMIT_KIND_MONTHLY",
            "PLAN_LIMIT_KIND_PER_MINUTE",
            "PLAN_LIMIT_KIND_UNLIMITED",
            "PLAN_LIMIT_KIND_METERED"
          ],
          "title": "How the limit behaves"
        },
        "value": {
          "description": "The ceiling. Absent when kind is PLAN_LIMIT_KIND_UNLIMITED or PLAN_LIMIT_KIND_METERED.",
          "format": "int32",
          "type": "integer"
        }
      },
      "title": "PlanLimit is one number a plan puts on something",
      "type": "object"
    },
    "PlanLimitKey": {
      "default": "PLAN_LIMIT_KEY_UNSPECIFIED",
      "description": "- PLAN_LIMIT_KEY_UNSPECIFIED: Not set\n - PLAN_LIMIT_KEY_CUSTOM_DOMAINS: Custom domains connected to the workspace\n - PLAN_LIMIT_KEY_TEAM_MEMBERS: Members of the workspace\n - PLAN_LIMIT_KEY_PLATFORM_CREDITS: Platform credits, spent by creating links and by AI features\n - PLAN_LIMIT_KEY_TRACKED_VISITS: Tracked visits (scans and clicks)\n - PLAN_LIMIT_KEY_PUBLIC_API_CALLS: Public API calls\n - PLAN_LIMIT_KEY_WEBHOOKS: Webhooks configured in the workspace\n - PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE: Assistant messages per minute\n - PLAN_LIMIT_KEY_LINKS_INCLUDED: Links the monthly platform credits pay for. Links are not capped on their own: each one spends credits.\n - PLAN_LIMIT_KEY_MEDIA_STORAGE_MB: Megabytes of uploaded media (media for Open media steps, QR code logos, page theme images) the workspace may hold at once. A standing total: deleting media frees it.",
      "enum": [
        "PLAN_LIMIT_KEY_UNSPECIFIED",
        "PLAN_LIMIT_KEY_CUSTOM_DOMAINS",
        "PLAN_LIMIT_KEY_TEAM_MEMBERS",
        "PLAN_LIMIT_KEY_PLATFORM_CREDITS",
        "PLAN_LIMIT_KEY_TRACKED_VISITS",
        "PLAN_LIMIT_KEY_PUBLIC_API_CALLS",
        "PLAN_LIMIT_KEY_WEBHOOKS",
        "PLAN_LIMIT_KEY_ASSISTANT_MESSAGES_PER_MINUTE",
        "PLAN_LIMIT_KEY_LINKS_INCLUDED",
        "PLAN_LIMIT_KEY_MEDIA_STORAGE_MB"
      ],
      "title": "PlanLimitKey names one thing a plan puts a number on",
      "type": "string"
    },
    "PlanLimitKind": {
      "default": "PLAN_LIMIT_KIND_UNSPECIFIED",
      "description": "- PLAN_LIMIT_KIND_UNSPECIFIED: Not set\n - PLAN_LIMIT_KIND_TOTAL: A standing total that does not refill, such as connected domains\n - PLAN_LIMIT_KIND_MONTHLY: An allowance that refills every month\n - PLAN_LIMIT_KIND_PER_MINUTE: A rate that refills every minute\n - PLAN_LIMIT_KIND_UNLIMITED: No ceiling\n - PLAN_LIMIT_KIND_METERED: No ceiling; every unit is billed",
      "enum": [
        "PLAN_LIMIT_KIND_UNSPECIFIED",
        "PLAN_LIMIT_KIND_TOTAL",
        "PLAN_LIMIT_KIND_MONTHLY",
        "PLAN_LIMIT_KIND_PER_MINUTE",
        "PLAN_LIMIT_KIND_UNLIMITED",
        "PLAN_LIMIT_KIND_METERED"
      ],
      "title": "PlanLimitKind says how a limit behaves",
      "type": "string"
    },
    "PricingPlanId": {
      "default": "PRICING_PLAN_ID_UNSPECIFIED",
      "description": "- PRICING_PLAN_ID_UNSPECIFIED: Not set\n - PRICING_PLAN_ID_FREE: Free plan, no payment\n - PRICING_PLAN_ID_LIGHT: Light plan\n - PRICING_PLAN_ID_PRO: Pro plan. Trials and sponsored workspaces are allowed what Pro allows unless a limit says otherwise.\n - PRICING_PLAN_ID_ENTERPRISE: Enterprise plan, billed on usage and priced on request through sales",
      "enum": [
        "PRICING_PLAN_ID_UNSPECIFIED",
        "PRICING_PLAN_ID_FREE",
        "PRICING_PLAN_ID_LIGHT",
        "PRICING_PLAN_ID_PRO",
        "PRICING_PLAN_ID_ENTERPRISE"
      ],
      "title": "PricingPlanId identifies a plan a workspace can subscribe to",
      "type": "string"
    },
    "WorkspaceAllowance": {
      "description": "One limit the workspace's plan sets, with what the workspace has used of it.",
      "properties": {
        "cheapestActionCost": {
          "format": "int32",
          "title": "Platform credits only: the credits the cheapest action that spends them needs before it runs",
          "type": "integer"
        },
        "cycleEndAt": {
          "description": "The last second of the current cycle; the allowance refills one second later. Absent for totals that never refill and when nothing has been counted yet.",
          "format": "date-time",
          "type": "string"
        },
        "cycleStartAt": {
          "description": "Start of the current cycle. Absent when nothing has been counted yet.",
          "format": "date-time",
          "type": "string"
        },
        "key": {
          "$ref": "#/$defs/PlanLimitKey",
          "title": "What the limit is on"
        },
        "kind": {
          "$ref": "#/$defs/PlanLimitKind",
          "title": "How the limit behaves"
        },
        "limit": {
          "description": "The ceiling. Absent when kind is PLAN_LIMIT_KIND_UNLIMITED or PLAN_LIMIT_KIND_METERED.",
          "format": "int32",
          "type": "integer"
        },
        "limitBytes": {
          "description": "Media storage only: the most media the workspace may hold, in bytes. Absent for other limits and when there is no ceiling.",
          "format": "int64",
          "type": "integer"
        },
        "lockedCount": {
          "description": "Tracked visits only: visits recorded past the limit in the current cycle that the workspace's plan still locks. Absent for other limits.",
          "format": "int32",
          "type": "integer"
        },
        "lockedTotalCount": {
          "description": "Tracked visits only: every visit the workspace's plan still locks, across all cycles. Upgrading to a plan with a higher limit reveals them. Absent for other limits.",
          "format": "int32",
          "type": "integer"
        },
        "noticeDismissed": {
          "title": "Whether the calling member dismissed the over-limit notice for this limit in the current cycle",
          "type": "boolean"
        },
        "reached": {
          "description": "Whether the limit is used up for the current cycle. Platform credits count as reached once neither the monthly credits nor the purchased top-up credits hold cheapest_action_cost, so nothing that spends credits can run. Never reached on a plan billed per unit used.",
          "type": "boolean"
        },
        "recordedCount": {
          "description": "Tracked visits only: every visit recorded in the current cycle, used plus locked_count. Absent for other limits.",
          "format": "int32",
          "type": "integer"
        },
        "remaining": {
          "description": "Units left in the current cycle. For platform credits, the monthly credits left plus the purchased top-up credits left. Absent when there is no ceiling.",
          "format": "int32",
          "type": "integer"
        },
        "resetsOn": {
          "$ref": "#/$defs/typeDate",
          "description": "The day the allowance refills, which is the first day of the next cycle in the workspace's timezone. Absent for totals that never refill and when nothing has been counted yet."
        },
        "used": {
          "description": "Units used in the current cycle. For a total such as custom domains, what the workspace holds.",
          "format": "int32",
          "type": "integer"
        },
        "usedBytes": {
          "description": "Media storage only: the bytes the workspace's media holds, exact. used is the same figure in megabytes, rounded up. Absent for other limits.",
          "format": "int64",
          "type": "integer"
        }
      },
      "title": "WorkspaceAllowance",
      "type": "object"
    },
    "typeDate": {
      "description": "* A full date, with non-zero year, month, and day values\n* A month and day value, with a zero year, such as an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, such as a credit card expiration\ndate\n\nRelated types are [google.type.TimeOfDay][google.type.TimeOfDay] and\n`google.protobuf.Timestamp`.",
      "properties": {
        "day": {
          "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant.",
          "format": "int32",
          "type": "integer"
        },
        "month": {
          "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day.",
          "format": "int32",
          "type": "integer"
        },
        "year": {
          "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year.",
          "format": "int32",
          "type": "integer"
        }
      },
      "title": "Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:",
      "type": "object"
    }
  }
}