Usage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/antwork-io/json-schema/antwork-io-usage-schema.json",
  "title": "Usage",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/antwork-io-openapi.json#/components/schemas/Usage",
  "type": "object",
  "required": [
    "object",
    "plan",
    "posts",
    "workspaces"
  ],
  "properties": {
    "object": {
      "const": "usage"
    },
    "plan": {
      "type": "string"
    },
    "posts": {
      "type": "object",
      "description": "Posts committed this billing cycle. With `unlimited: true` nothing is counted: `used` is 0, `limit` and `remaining` null.",
      "properties": {
        "used": {
          "type": "integer"
        },
        "limit": {
          "type": [
            "integer",
            "null"
          ]
        },
        "remaining": {
          "type": [
            "integer",
            "null"
          ]
        },
        "unlimited": {
          "type": "boolean"
        },
        "cycleStart": {
          "type": "string",
          "format": "date-time"
        },
        "cycleEnd": {
          "type": "string",
          "format": "date-time"
        },
        "usageUnavailable": {
          "const": true,
          "description": "The count could not be taken; `used` is unknown."
        }
      }
    },
    "workspaces": {
      "type": "object",
      "properties": {
        "used": {
          "type": "integer"
        },
        "limit": {
          "type": [
            "integer",
            "null"
          ]
        },
        "remaining": {
          "type": [
            "integer",
            "null"
          ]
        },
        "unlimited": {
          "type": "boolean"
        }
      }
    },
    "billing": {
      "type": "object",
      "description": "Where to change the plan and what is time-limited or scheduled. Present for accounts on the Free/Pro/Business/Scale/Agency plans.",
      "required": [
        "billingUrl"
      ],
      "properties": {
        "billingUrl": {
          "type": "string",
          "format": "uri",
          "description": "The plan page: upgrade, switch, cancel, claim the founding offer."
        },
        "interval": {
          "enum": [
            "month",
            "year"
          ],
          "description": "A paid plan's billing period."
        },
        "renewsAt": {
          "type": "string",
          "format": "date-time",
          "description": "When a paid plan renews, or ends if `cancelsAtPeriodEnd`."
        },
        "cancelsAtPeriodEnd": {
          "const": true,
          "description": "The paid plan moves to Free at `renewsAt`."
        },
        "scheduledChange": {
          "type": "object",
          "description": "A downgrade waiting for the renewal.",
          "properties": {
            "plan": {
              "type": "string"
            },
            "interval": {
              "enum": [
                "month",
                "year"
              ]
            },
            "at": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            }
          }
        },
        "foundingOffer": {
          "type": "object",
          "description": "`percentOff` off the first year of any yearly plan, bought before `endsAt`. Only while the account can still take it.",
          "properties": {
            "percentOff": {
              "type": "integer"
            },
            "endsAt": {
              "type": "string",
              "format": "date-time"
            }
          }
        },
        "unlimitedPostsUntil": {
          "type": "string",
          "format": "date-time",
          "description": "Unlimited posts end then; Free allows `postsPerMonthAfter` a month after."
        },
        "postsPerMonthAfter": {
          "type": "integer"
        }
      }
    }
  }
}