action zoom_account_plans {
  label: "Get plan Information"
  description: "Get plan information of a sub account that is managed by a master account. <br><br>This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details.<br><br>\n**Scopes:** `billing:master`<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n\n\n "
  provider: zoom
  method: GET
  path: "/accounts/{accountId}/plans"
  encoding: json
  input: {
    type: "object"
    properties: {
      accountId: {
        type: "string"
      }
    }
    required: ["accountId"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      plan_audio: {
        type: "object"
        description: "Additional audio conferencing <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#audio-conferencing-plans\">plan type.</a>"
        properties: {
          callout_countries: {
            type: "string"
            description: "Call-out countries: multiple values should separated by  commas. For a list of allowed values, refer to the \"ID\" field in [this](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#tsp-call-out-countries) table."
          }
          ddi_numbers: {
            type: "integer"
            description: "Dedicated dial-In numbers."
          }
          next_invoice_date: {
            type: "string"
            description: "Next invoice date for the plan."
          }
          premium_countries: {
            type: "string"
            description: "Premium countries: multiple values should be separated by commas. For a list of allowed values, refer to the \"ID\" field in the [Premium Countries](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#premium-countries) table."
          }
          service_effective_date: {
            type: "string"
            description: "Date at which the plan became effective on the account."
          }
          status: {
            type: "string"
            description: "Status of the plan."
            enum: ["active", "cancel", "expired"]
          }
          tollfree_countries: {
            type: "string"
            description: "Toll-free countries: multiple values should separated by a comma. For a list of allowed values, refer to the \"ID\" field in the [Toll Free Countries](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#toll-free-countries) table."
          }
          type: {
            type: "string"
            description: "Additional audio conferencing <a href=\"/api-reference/other-references/plans\">plan type.</a>"
          }
        }
      }
      plan_base: {
        type: "object"
        properties: {
          hosts: {
            type: "integer"
            description: "Account base plan number of hosts. For a Pro Plan please select a value between 1 and 9. For a Business Plan please select a value between 10 and 49. For a Education Plan please select a value between 20 and 149. For a Free Trial Plan please select a value between 1 and 9999."
          }
          next_invoice_date: {
            type: "string"
            description: "Next invoice date for the plan."
          }
          service_effective_date: {
            type: "string"
            description: "Date at which the plan became effective on the account."
          }
          status: {
            type: "string"
            description: "Status of the plan."
            enum: ["active", "cancel", "expired"]
          }
          type: {
            type: "string"
            description: "Account base <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
          }
        }
      }
      plan_large_meeting: {
        type: "array"
        items: {
          type: "object"
          description: "Account plan object."
          properties: {
            hosts: {
              type: "integer"
              description: "Account plan number of hosts."
            }
            next_invoice_date: {
              type: "string"
              description: "Next invoice date for the plan."
            }
            service_effective_date: {
              type: "string"
              description: "Date at which the plan became effective on the account."
            }
            status: {
              type: "string"
              description: "Status of the plan."
              enum: ["active", "cancel", "expired"]
            }
            type: {
              type: "string"
              description: "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
            }
          }
        }
      }
      plan_phone: {
        type: "object"
        description: "Phone Plan Object"
        properties: {
          plan_base: {
            type: "object"
            description: "Additional phone base plans."
            properties: {
              callout_countries: {
                type: "string"
                description: "Call-out countries: multiple values should separated by  commas. For a list of allowed values, refer to the \"ID\" field in [this](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#tsp-call-out-countries) table."
              }
              next_invoice_date: {
                type: "string"
                description: "Next invoice date for the plan."
              }
              service_effective_date: {
                type: "string"
                description: "Date at which the plan became effective on the account."
              }
              status: {
                type: "string"
                description: "Status of the plan."
                enum: ["active", "cancel", "expired"]
              }
              type: {
                type: "string"
                description: "Additional phone base <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans\">plan type.</a>"
              }
            }
          }
          plan_calling: {
            type: "array"
            description: "Additional phone calling plans."
            items: {
              type: "object"
              properties: {
                hosts: {
                  type: "integer"
                }
                next_invoice_date: {
                  type: "string"
                  description: "Next invoice date for the plan."
                }
                service_effective_date: {
                  type: "string"
                  description: "Date at which the plan became effective on the account."
                }
                status: {
                  type: "string"
                  description: "Status of the plan."
                  enum: ["active", "cancel", "expired"]
                }
                type: {
                  type: "string"
                  description: "Additional phone calling <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans\">plan type.</a>"
                }
              }
            }
          }
          plan_number: {
            type: "array"
            description: "Additional phone number plans."
            items: {
              type: "object"
              properties: {
                hosts: {
                  type: "integer"
                }
                next_invoice_date: {
                  type: "string"
                  description: "Next invoice date for the plan."
                }
                service_effective_date: {
                  type: "string"
                  description: "Date at which the plan became effective on the account."
                }
                status: {
                  type: "string"
                  description: "Status of the plan."
                  enum: ["active", "cancel", "expired"]
                }
                type: {
                  type: "string"
                  description: "Additional phone number <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans\">plan type.</a>"
                }
              }
            }
          }
        }
      }
      plan_recording: {
        type: "string"
        description: "Additional Cloud Recording plan."
      }
      plan_recording_next_invoice_date: {
        type: "string"
        description: "Next invoice date of Additional Cloud Recording plan."
      }
      plan_recording_service_effective_date: {
        type: "string"
        description: "Plan start date of Additional Cloud Recording plan."
      }
      plan_recording_status: {
        type: "string"
        description: "Status of additional Cloud Recording plan."
        enum: ["Active", "Cancelled"]
      }
      plan_room_connector: {
        type: "object"
        properties: {
          hosts: {
            type: "integer"
            description: "Account plan number of hosts."
          }
          next_invoice_date: {
            type: "string"
            description: "Next invoice date for the plan."
          }
          service_effective_date: {
            type: "string"
            description: "Date at which the plan became effective on the account."
          }
          status: {
            type: "string"
            description: "Status of the plan."
            enum: ["active", "cancel", "expired"]
          }
          type: {
            type: "string"
            description: "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
          }
        }
      }
      plan_webinar: {
        type: "array"
        items: {
          type: "object"
          description: "Account plan object."
          properties: {
            hosts: {
              type: "integer"
              description: "Account plan number of hosts."
            }
            next_invoice_date: {
              type: "string"
              description: "Next invoice date for the plan."
            }
            service_effective_date: {
              type: "string"
              description: "Date at which the plan became effective on the account."
            }
            status: {
              type: "string"
              description: "Status of the plan."
              enum: ["active", "cancel", "expired"]
            }
            type: {
              type: "string"
              description: "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
            }
          }
        }
      }
      plan_zoom_rooms: {
        type: "object"
        properties: {
          hosts: {
            type: "integer"
            description: "Account plan number of hosts."
          }
          next_invoice_date: {
            type: "string"
            description: "Next invoice date for the plan."
          }
          service_effective_date: {
            type: "string"
            description: "Date at which the plan became effective on the account."
          }
          status: {
            type: "string"
            description: "Status of the plan."
            enum: ["active", "cancel", "expired"]
          }
          type: {
            type: "string"
            description: "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
          }
        }
      }
    }
  }
}