Chilkat Online Tools

Xojo / Zoom API / Get plan usage

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.zoom.us/v2/accounts/:accountId/plans/usage",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "plan_base": {
//     "type": "monthly",
//     "hosts": 2,
//     "usage": 1
//   },
//   "plan_zoom_rooms": {
//     "type": "zroom_monthly",
//     "hosts": 1,
//     "usage": 0
//   },
//   "plan_webinar": [
//     {
//       "type": "webinar1000",
//       "hosts": 1,
//       "usage": 1
//     }
//   ],
//   "plan_zoom_events": [
//     {
//       "type": "zoomevents500_monthly",
//       "hosts": 1,
//       "usage": 1
//     }
//   ],
//   "plan_large_meeting": [
//     {
//       "type": "large500_monthly",
//       "hosts": 1,
//       "usage": 1
//     }
//   ],
//   "plan_recording": {
//     "free_storage": "3 GB",
//     "free_storage_usage": "0",
//     "plan_storage": "0",
//     "plan_storage_usage": "0",
//     "plan_storage_exceed": "0"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim v_type As String
Dim hosts As Int32
Dim usage As Int32

Dim v_Type As String
v_Type = jResp.StringOf("plan_base.type")
Dim Hosts As Int32
Hosts = jResp.IntOf("plan_base.hosts")
Dim Usage As Int32
Usage = jResp.IntOf("plan_base.usage")
Dim plan_zoom_roomsType As String
plan_zoom_roomsType = jResp.StringOf("plan_zoom_rooms.type")
Dim plan_zoom_roomsHosts As Int32
plan_zoom_roomsHosts = jResp.IntOf("plan_zoom_rooms.hosts")
Dim plan_zoom_roomsUsage As Int32
plan_zoom_roomsUsage = jResp.IntOf("plan_zoom_rooms.usage")
Dim Free_storage As String
Free_storage = jResp.StringOf("plan_recording.free_storage")
Dim Free_storage_usage As String
Free_storage_usage = jResp.StringOf("plan_recording.free_storage_usage")
Dim Plan_storage As String
Plan_storage = jResp.StringOf("plan_recording.plan_storage")
Dim Plan_storage_usage As String
Plan_storage_usage = jResp.StringOf("plan_recording.plan_storage_usage")
Dim Plan_storage_exceed As String
Plan_storage_exceed = jResp.StringOf("plan_recording.plan_storage_exceed")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("plan_webinar")
While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("plan_webinar[i].type")
    hosts = jResp.IntOf("plan_webinar[i].hosts")
    usage = jResp.IntOf("plan_webinar[i].usage")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("plan_zoom_events")
While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("plan_zoom_events[i].type")
    hosts = jResp.IntOf("plan_zoom_events[i].hosts")
    usage = jResp.IntOf("plan_zoom_events[i].usage")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("plan_large_meeting")
While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("plan_large_meeting[i].type")
    hosts = jResp.IntOf("plan_large_meeting[i].hosts")
    usage = jResp.IntOf("plan_large_meeting[i].usage")
    i = i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/plans/usage

Postman Collection Item JSON

{
  "name": "Get plan usage",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/accounts/:accountId/plans/usage",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "accounts",
        ":accountId",
        "plans",
        "usage"
      ],
      "variable": [
        {
          "key": "accountId"
        }
      ]
    },
    "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`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` <br>\nPlan Usage returned.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/accounts/:accountId/plans/usage",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "accounts",
            ":accountId",
            "plans",
            "usage"
          ],
          "variable": [
            {
              "key": "accountId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"plan_base\": {\n  \"type\": \"monthly\",\n  \"hosts\": 2,\n  \"usage\": 1\n },\n \"plan_zoom_rooms\": {\n  \"type\": \"zroom_monthly\",\n  \"hosts\": 1,\n  \"usage\": 0\n },\n \"plan_webinar\": [\n  {\n   \"type\": \"webinar1000\",\n   \"hosts\": 1,\n   \"usage\": 1\n  }\n ],\n \"plan_zoom_events\": [\n  {\n   \"type\": \"zoomevents500_monthly\",\n   \"hosts\": 1,\n   \"usage\": 1\n  }\n ],\n \"plan_large_meeting\": [\n  {\n   \"type\": \"large500_monthly\",\n   \"hosts\": 1,\n   \"usage\": 1\n  }\n ],\n \"plan_recording\": {\n  \"free_storage\": \"3 GB\",\n  \"free_storage_usage\": \"0\",\n  \"plan_storage\": \"0\",\n  \"plan_storage_usage\": \"0\",\n  \"plan_storage_exceed\": \"0\"\n }\n}"
    },
    {
      "name": "**HTTP Status Code:** `400` <br>\n**Error Code:** `200` <br>\nOnly available for paid account.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/accounts/:accountId/plans/usage",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "accounts",
            ":accountId",
            "plans",
            "usage"
          ],
          "variable": [
            {
              "key": "accountId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}