action zoom_get_plan_usage {
  label: "Get plan usage"
  description: "Get information on usage of [plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans) of an account. This API supports regular accounts as well as master and sub accounts. To get plan usage of a regular account, use the `account:read:admin` scope and provide “me” as the value of the  `accountId` path parameter.To get plan usage of a master account, provide the keyword \"me\" as the value of the `accountId` path parameter and use the `billing:master` scope. To get plan usage of a sub account, provide the actual account Id of the sub account as the value of the `accountId` path parameter and use the `billing:master` scope. \n\n**Prerequisite**:<br>\nAccount type: master account on a paid Pro, Business or Enterprise plan.<br>\n**Scope:** `billing:master` for master and sub accounts. `account:read:admin` for regular Zoom accounts.<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
  provider: zoom
  method: GET
  path: "/accounts/{accountId}/plans/usage"
  encoding: json
  output: {
    type: "object"
    properties: {
      plan_base: {
        type: "array"
        description: "The base plan subscribed for the sub account."
        items: {
          type: "object"
          properties: {
            hosts: {
              type: "integer"
              description: "Number of hosts under the base plan."
            }
            type: {
              type: "string"
              description: "Type of the base plan. "
            }
            usage: {
              type: "integer"
              description: "Total number of usage of this plan."
            }
          }
        }
      }
      plan_large_meeting: {
        type: "array"
        description: "Large Meeting Plan"
        items: {
          type: "object"
          properties: {
            hosts: {
              type: "integer"
              description: "Number of hosts in this plan. "
            }
            type: {
              type: "string"
              description: "Large meeting Plan Type"
            }
            usage: {
              type: "integer"
              description: "Number of usages for this account plan."
            }
          }
        }
      }
      plan_recording: {
        type: "object"
        description: "Recording Plan"
        properties: {
          free_storage: {
            type: "string"
            description: "Recording free storage."
          }
          free_storage_usage: {
            type: "string"
            description: "Amount of free storage used."
          }
          plan_storage: {
            type: "string"
            description: "Recording plan storage."
          }
          plan_storage_exceed: {
            type: "string"
          }
          plan_storage_usage: {
            type: "string"
            description: "Recording storage usage."
          }
          type: {
            type: "string"
            description: "Recording plan type."
          }
        }
      }
      plan_united: {
        type: "object"
        description: "[Zoom United](https://zoom.us/pricing/zoom-bundles) plan."
        properties: {
          hosts: {
            type: "integer"
            description: "Number of licenses purchased."
          }
          name: {
            type: "string"
            description: "Name of the plan."
          }
          type: {
            type: "string"
            description: "Plan [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-united-plans)."
          }
          usage: {
            type: "integer"
            description: "Number of licenses that are already being used."
          }
        }
      }
      plan_webinar: {
        type: "array"
        description: "Webinar Plan"
        items: {
          type: "object"
          properties: {
            hosts: {
              type: "integer"
              description: "The number of hosts in this plan."
            }
            type: {
              type: "string"
              description: "The type of Webinar plan for the account."
            }
            usage: {
              type: "integer"
              description: "The total number of plan usage."
            }
          }
        }
      }
      plan_zoom_rooms: {
        type: "array"
        description: "Zoom Rooms Plan"
        items: {
          type: "object"
          properties: {
            hosts: {
              type: "integer"
              description: "The number of hosts in this plan."
            }
            type: {
              type: "string"
              description: "THe plan type for Zoom room plan."
            }
            usage: {
              type: "integer"
              description: "The total number of usage for this plan."
            }
          }
        }
      }
    }
  }
}