Node.js / Zoom API / Get account plan information
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
var sbResponseBody = new chilkat.StringBuilder();
success = http.QuickGetSb("https://api.zoom.us/v2/accounts/:accountId/plans",sbResponseBody);
if (success == false) {
console.log(http.LastErrorText);
return;
}
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(http.LastHeader);
console.log("Failed.");
return;
}
// 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
var v_type;
var hosts;
var service_effective_date;
var next_invoice_date;
var status;
var v_Type = jResp.StringOf("plan_base.type");
var Hosts = jResp.IntOf("plan_base.hosts");
var Service_effective_date = jResp.StringOf("plan_base.service_effective_date");
var Next_invoice_date = jResp.StringOf("plan_base.next_invoice_date");
var Status = jResp.StringOf("plan_base.status");
var plan_zoom_roomsType = jResp.StringOf("plan_zoom_rooms.type");
var plan_zoom_roomsHosts = jResp.IntOf("plan_zoom_rooms.hosts");
var plan_zoom_roomsService_effective_date = jResp.StringOf("plan_zoom_rooms.service_effective_date");
var plan_zoom_roomsNext_invoice_date = jResp.StringOf("plan_zoom_rooms.next_invoice_date");
var plan_zoom_roomsStatus = jResp.StringOf("plan_zoom_rooms.status");
var plan_room_connectorType = jResp.StringOf("plan_room_connector.type");
var plan_room_connectorHosts = jResp.IntOf("plan_room_connector.hosts");
var plan_room_connectorService_effective_date = jResp.StringOf("plan_room_connector.service_effective_date");
var plan_room_connectorNext_invoice_date = jResp.StringOf("plan_room_connector.next_invoice_date");
var plan_room_connectorStatus = jResp.StringOf("plan_room_connector.status");
var plan_recording = jResp.StringOf("plan_recording");
var plan_recording_service_effective_date = jResp.StringOf("plan_recording_service_effective_date");
var plan_recording_next_invoice_date = jResp.StringOf("plan_recording_next_invoice_date");
var plan_recording_status = jResp.StringOf("plan_recording_status");
var plan_audioType = jResp.StringOf("plan_audio.type");
var Tollfree_countries = jResp.StringOf("plan_audio.tollfree_countries");
var Premium_countries = jResp.StringOf("plan_audio.premium_countries");
var Callout_countries = jResp.StringOf("plan_audio.callout_countries");
var Ddi_numbers = jResp.IntOf("plan_audio.ddi_numbers");
var plan_audioService_effective_date = jResp.StringOf("plan_audio.service_effective_date");
var plan_audioNext_invoice_date = jResp.StringOf("plan_audio.next_invoice_date");
var plan_audioStatus = jResp.StringOf("plan_audio.status");
var Plan_baseType = jResp.StringOf("plan_phone.plan_base.type");
var Plan_baseCallout_countries = jResp.StringOf("plan_phone.plan_base.callout_countries");
var Plan_baseService_effective_date = jResp.StringOf("plan_phone.plan_base.service_effective_date");
var Plan_baseNext_invoice_date = jResp.StringOf("plan_phone.plan_base.next_invoice_date");
var Plan_baseStatus = jResp.StringOf("plan_phone.plan_base.status");
var i = 0;
var 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");
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;
}
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;
}
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;
}
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;
}
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;
}
}
chilkatExample();
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": ""
}
]
}
