VB.NET / Zoom API / Get account plan information
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",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "plan_base": {
' "type": "monthly",
' "hosts": 100,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' },
' "plan_zoom_rooms": {
' "type": "zroom_monthly",
' "hosts": 50,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' },
' "plan_room_connector": {
' "type": "roomconnector_monthly",
' "hosts": 10,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' },
' "plan_large_meeting": [
' {
' "type": "plan_large500_two_years",
' "hosts": 10,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' }
' ],
' "plan_webinar": [
' {
' "type": "webinar500_monthly",
' "hosts": 10,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' }
' ],
' "plan_zoom_events": [
' {
' "type": "zoomevents500_monthly",
' "hosts": 20,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' }
' ],
' "plan_recording": "cmr_monthly_commitment_40",
' "plan_recording_service_effective_date": "2021-09-07T00:00:00Z",
' "plan_recording_next_invoice_date": "2021-10-07T00:00:00Z",
' "plan_recording_status": "status",
' "plan_audio": {
' "type": "tollfree_payongo",
' "tollfree_countries": "US",
' "premium_countries": "",
' "callout_countries": "",
' "ddi_numbers": 0,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' },
' "plan_phone": {
' "plan_base": {
' "type": "phone_payongo",
' "callout_countries": "",
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' },
' "plan_calling": [
' {
' "type": "phone_calling_usca_monthly_unlimited",
' "hosts": 5,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' }
' ],
' "plan_number": [
' {
' "type": "phone_number_usca_monthly",
' "hosts": 5,
' "service_effective_date": "2021-09-07T00:00:00Z",
' "next_invoice_date": "2021-10-07T00:00:00Z",
' "status": "active"
' }
' ]
' }
' }
' 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 Integer
Dim service_effective_date As String
Dim next_invoice_date As String
Dim status As String
Dim v_Type As String = jResp.StringOf("plan_base.type")
Dim Hosts As Integer = jResp.IntOf("plan_base.hosts")
Dim Service_effective_date As String = jResp.StringOf("plan_base.service_effective_date")
Dim Next_invoice_date As String = jResp.StringOf("plan_base.next_invoice_date")
Dim Status As String = jResp.StringOf("plan_base.status")
Dim plan_zoom_roomsType As String = jResp.StringOf("plan_zoom_rooms.type")
Dim plan_zoom_roomsHosts As Integer = jResp.IntOf("plan_zoom_rooms.hosts")
Dim plan_zoom_roomsService_effective_date As String = jResp.StringOf("plan_zoom_rooms.service_effective_date")
Dim plan_zoom_roomsNext_invoice_date As String = jResp.StringOf("plan_zoom_rooms.next_invoice_date")
Dim plan_zoom_roomsStatus As String = jResp.StringOf("plan_zoom_rooms.status")
Dim plan_room_connectorType As String = jResp.StringOf("plan_room_connector.type")
Dim plan_room_connectorHosts As Integer = jResp.IntOf("plan_room_connector.hosts")
Dim plan_room_connectorService_effective_date As String = jResp.StringOf("plan_room_connector.service_effective_date")
Dim plan_room_connectorNext_invoice_date As String = jResp.StringOf("plan_room_connector.next_invoice_date")
Dim plan_room_connectorStatus As String = jResp.StringOf("plan_room_connector.status")
Dim plan_recording As String = jResp.StringOf("plan_recording")
Dim plan_recording_service_effective_date As String = jResp.StringOf("plan_recording_service_effective_date")
Dim plan_recording_next_invoice_date As String = jResp.StringOf("plan_recording_next_invoice_date")
Dim plan_recording_status As String = jResp.StringOf("plan_recording_status")
Dim plan_audioType As String = jResp.StringOf("plan_audio.type")
Dim Tollfree_countries As String = jResp.StringOf("plan_audio.tollfree_countries")
Dim Premium_countries As String = jResp.StringOf("plan_audio.premium_countries")
Dim Callout_countries As String = jResp.StringOf("plan_audio.callout_countries")
Dim Ddi_numbers As Integer = jResp.IntOf("plan_audio.ddi_numbers")
Dim plan_audioService_effective_date As String = jResp.StringOf("plan_audio.service_effective_date")
Dim plan_audioNext_invoice_date As String = jResp.StringOf("plan_audio.next_invoice_date")
Dim plan_audioStatus As String = jResp.StringOf("plan_audio.status")
Dim Plan_baseType As String = jResp.StringOf("plan_phone.plan_base.type")
Dim Plan_baseCallout_countries As String = jResp.StringOf("plan_phone.plan_base.callout_countries")
Dim Plan_baseService_effective_date As String = jResp.StringOf("plan_phone.plan_base.service_effective_date")
Dim Plan_baseNext_invoice_date As String = jResp.StringOf("plan_phone.plan_base.next_invoice_date")
Dim Plan_baseStatus As String = jResp.StringOf("plan_phone.plan_base.status")
Dim i As Integer = 0
Dim count_i As Integer = 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")
service_effective_date = jResp.StringOf("plan_large_meeting[i].service_effective_date")
next_invoice_date = jResp.StringOf("plan_large_meeting[i].next_invoice_date")
status = jResp.StringOf("plan_large_meeting[i].status")
i = i + 1
End While
i = 0
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")
service_effective_date = jResp.StringOf("plan_webinar[i].service_effective_date")
next_invoice_date = jResp.StringOf("plan_webinar[i].next_invoice_date")
status = jResp.StringOf("plan_webinar[i].status")
i = i + 1
End While
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")
service_effective_date = jResp.StringOf("plan_zoom_events[i].service_effective_date")
next_invoice_date = jResp.StringOf("plan_zoom_events[i].next_invoice_date")
status = jResp.StringOf("plan_zoom_events[i].status")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("plan_phone.plan_calling")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("plan_phone.plan_calling[i].type")
hosts = jResp.IntOf("plan_phone.plan_calling[i].hosts")
service_effective_date = jResp.StringOf("plan_phone.plan_calling[i].service_effective_date")
next_invoice_date = jResp.StringOf("plan_phone.plan_calling[i].next_invoice_date")
status = jResp.StringOf("plan_phone.plan_calling[i].status")
i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("plan_phone.plan_number")
While i < count_i
jResp.I = i
v_type = jResp.StringOf("plan_phone.plan_number[i].type")
hosts = jResp.IntOf("plan_phone.plan_number[i].hosts")
service_effective_date = jResp.StringOf("plan_phone.plan_number[i].service_effective_date")
next_invoice_date = jResp.StringOf("plan_phone.plan_number[i].next_invoice_date")
status = jResp.StringOf("plan_phone.plan_number[i].status")
i = i + 1
End While
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/plans
Postman Collection Item JSON
{
"name": "Get account plan information",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/plans",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"plans"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
},
"description": "Use this API to return plan information of a subaccount that is managed by a Master account. \n\n This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher subaccounts. Zoom only allows approved partners to use [Master APIs](https://marketplace.zoom.us/docs/api-reference/master-account-apis) and manage subaccounts' billing information. Email the partner programs team at [**partner-success@zoom.us**](mailto:partner-success@zoom.us) for more details. \n\n **Scopes:** `billing:master`, `billing:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:**`200`<br>\nAccount's plans returned.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/plans",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"plans"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"plan_base\": {\n \"type\": \"monthly\",\n \"hosts\": 100,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n },\n \"plan_zoom_rooms\": {\n \"type\": \"zroom_monthly\",\n \"hosts\": 50,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n },\n \"plan_room_connector\": {\n \"type\": \"roomconnector_monthly\",\n \"hosts\": 10,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n },\n \"plan_large_meeting\": [\n {\n \"type\": \"plan_large500_two_years\",\n \"hosts\": 10,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n }\n ],\n \"plan_webinar\": [\n {\n \"type\": \"webinar500_monthly\",\n \"hosts\": 10,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n }\n ],\n \"plan_zoom_events\": [\n {\n \"type\": \"zoomevents500_monthly\",\n \"hosts\": 20,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n }\n ],\n \"plan_recording\": \"cmr_monthly_commitment_40\",\n \"plan_recording_service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"plan_recording_next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"plan_recording_status\": \"status\",\n \"plan_audio\": {\n \"type\": \"tollfree_payongo\",\n \"tollfree_countries\": \"US\",\n \"premium_countries\": \"\",\n \"callout_countries\": \"\",\n \"ddi_numbers\": 0,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n },\n \"plan_phone\": {\n \"plan_base\": {\n \"type\": \"phone_payongo\",\n \"callout_countries\": \"\",\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n },\n \"plan_calling\": [\n {\n \"type\": \"phone_calling_usca_monthly_unlimited\",\n \"hosts\": 5,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n }\n ],\n \"plan_number\": [\n {\n \"type\": \"phone_number_usca_monthly\",\n \"hosts\": 5,\n \"service_effective_date\": \"2021-09-07T00:00:00Z\",\n \"next_invoice_date\": \"2021-10-07T00:00:00Z\",\n \"status\": \"active\"\n }\n ]\n }\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `2100`<br> \nThis sub account is on self pay mode.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/plans",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"plans"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:**`404`<br>\nAccount does not exist: {subAccountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/plans",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"plans"
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
