Chilkat Online Tools

Swift / Zoom API / Get plan usage

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.zoom.us/v2/accounts/:accountId/plans/usage", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

    // 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

    var v_type: String?
    var hosts: Int
    var usage: Int

    var v_Type: String? = jResp.StringOf("plan_base.type")
    var Hosts: Int = jResp.IntOf("plan_base.hosts").intValue
    var Usage: Int = jResp.IntOf("plan_base.usage").intValue
    var plan_zoom_roomsType: String? = jResp.StringOf("plan_zoom_rooms.type")
    var plan_zoom_roomsHosts: Int = jResp.IntOf("plan_zoom_rooms.hosts").intValue
    var plan_zoom_roomsUsage: Int = jResp.IntOf("plan_zoom_rooms.usage").intValue
    var Free_storage: String? = jResp.StringOf("plan_recording.free_storage")
    var Free_storage_usage: String? = jResp.StringOf("plan_recording.free_storage_usage")
    var Plan_storage: String? = jResp.StringOf("plan_recording.plan_storage")
    var Plan_storage_usage: String? = jResp.StringOf("plan_recording.plan_storage_usage")
    var Plan_storage_exceed: String? = jResp.StringOf("plan_recording.plan_storage_exceed")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("plan_webinar").intValue
    while i < count_i {
        jResp.I = i
        v_type = jResp.StringOf("plan_webinar[i].type")
        hosts = jResp.IntOf("plan_webinar[i].hosts").intValue
        usage = jResp.IntOf("plan_webinar[i].usage").intValue
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("plan_zoom_events").intValue
    while i < count_i {
        jResp.I = i
        v_type = jResp.StringOf("plan_zoom_events[i].type")
        hosts = jResp.IntOf("plan_zoom_events[i].hosts").intValue
        usage = jResp.IntOf("plan_zoom_events[i].usage").intValue
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("plan_large_meeting").intValue
    while i < count_i {
        jResp.I = i
        v_type = jResp.StringOf("plan_large_meeting[i].type")
        hosts = jResp.IntOf("plan_large_meeting[i].hosts").intValue
        usage = jResp.IntOf("plan_large_meeting[i].usage").intValue
        i = i + 1
    }


}

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": ""
    }
  ]
}