WorkspaceBillingResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/secure-flows-com/json-schema/secure-flows-com-workspace-billing-response-schema.json",
  "title": "WorkspaceBillingResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/secure-flows-user-api.yaml#/components/schemas/WorkspaceBillingResponse",
  "type": "object",
  "required": [
    "planName",
    "effectiveMaxConcurrentSessions",
    "effectiveMaxPayloadBytes",
    "billingStatus",
    "usage",
    "checkoutAvailable",
    "cancelAvailable",
    "overFreeTierLimits"
  ],
  "properties": {
    "planName": {
      "type": "string",
      "enum": [
        "free",
        "base",
        "pro"
      ],
      "description": "Assigned catalog plan"
    },
    "effectiveMaxConcurrentSessions": {
      "type": "integer",
      "description": "Enforced concurrent active session cap (override or plan default)"
    },
    "effectiveMaxPayloadBytes": {
      "type": "integer",
      "description": "Enforced decrypted payload UTF-8 byte cap (override or plan default)"
    },
    "overrideMaxConcurrentSessions": {
      "type": [
        "integer",
        "null"
      ],
      "description": "SUPPORT-only override when set; null when using plan default"
    },
    "overrideMaxPayloadBytes": {
      "type": [
        "integer",
        "null"
      ],
      "description": "SUPPORT-only override when set; null when using plan default"
    },
    "billingStatus": {
      "type": "string",
      "description": "Lifecycle status. Common values: `beta`, `active`, `trialing`, `past_due`,\n`canceling` (renewal stopped; paid until `paidPeriodEndsAt`),\n`grace_lock` (period ended without Free; end-user session I/O blocked until Free\ndowngrade or grace wipe), `canceled`.\n"
    },
    "usage": {
      "$ref": "#/$defs/WorkspaceBillingUsage"
    },
    "checkoutAvailable": {
      "type": "boolean",
      "description": "True when payment integration is enabled and the active provider is configured\n(staging). False on production Beta — console uses PATCH for plan changes.\n"
    },
    "paymentProvider": {
      "type": [
        "string",
        "null"
      ],
      "description": "Active provider id (e.g. `paddle`) when checkoutAvailable; otherwise null"
    },
    "paddleClientToken": {
      "type": [
        "string",
        "null"
      ],
      "description": "Paddle.js client token when checkoutAvailable"
    },
    "paddleEnvironment": {
      "type": [
        "string",
        "null"
      ],
      "description": "`sandbox` or `production` for Paddle.js when checkoutAvailable"
    },
    "cancelAvailable": {
      "type": "boolean",
      "description": "True when checkout is available and the workspace can cancel a paid subscription\n(or is already `canceling`). False on Free/Beta, `grace_lock`, and when payment is disabled.\n"
    },
    "paidPeriodEndsAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "End of already-paid entitlement after cancel (ISO-8601); null when not canceling"
    },
    "cancelRequestedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When cancel was requested; null when not canceling"
    },
    "overFreeTierLimits": {
      "type": "boolean",
      "description": "True when current usage exceeds Free-tier concurrent session and/or payload caps\n(useful for cancel confirmation copy).\n"
    },
    "resumeAvailable": {
      "type": "boolean",
      "description": "True when checkout is available and the workspace is `canceling` (undo cancel /\nresume auto-renewal via POST …/resume). False in `grace_lock`.\n"
    },
    "graceEndsAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When `billingStatus` is `grace_lock`, countdown to automatic wipe of all active\nsession payloads (ISO-8601). Null outside grace lock, including after wipe → Free.\n"
    }
  },
  "$defs": {
    "WorkspaceBillingUsage": {
      "type": "object",
      "required": [
        "activeSessionCount"
      ],
      "properties": {
        "activeSessionCount": {
          "type": "integer",
          "format": "int64",
          "description": "Active sessions in the workspace (same definition as billing enforcement)"
        },
        "largestActivePayloadBytes": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "description": "Max `currentDataSizeBytes` among active sessions, or null when none"
        }
      }
    }
  }
}