delphiAx / Zoom API / Get account plan information
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_type: WideString;
hosts: Integer;
service_effective_date: WideString;
next_invoice_date: WideString;
status: WideString;
v_Type: WideString;
Hosts: Integer;
Service_effective_date: WideString;
Next_invoice_date: WideString;
Status: WideString;
plan_zoom_roomsType: WideString;
plan_zoom_roomsHosts: Integer;
plan_zoom_roomsService_effective_date: WideString;
plan_zoom_roomsNext_invoice_date: WideString;
plan_zoom_roomsStatus: WideString;
plan_room_connectorType: WideString;
plan_room_connectorHosts: Integer;
plan_room_connectorService_effective_date: WideString;
plan_room_connectorNext_invoice_date: WideString;
plan_room_connectorStatus: WideString;
plan_recording: WideString;
plan_recording_service_effective_date: WideString;
plan_recording_next_invoice_date: WideString;
plan_recording_status: WideString;
plan_audioType: WideString;
Tollfree_countries: WideString;
Premium_countries: WideString;
Callout_countries: WideString;
Ddi_numbers: Integer;
plan_audioService_effective_date: WideString;
plan_audioNext_invoice_date: WideString;
plan_audioStatus: WideString;
Plan_baseType: WideString;
Plan_baseCallout_countries: WideString;
Plan_baseService_effective_date: WideString;
Plan_baseNext_invoice_date: WideString;
Plan_baseStatus: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.zoom.us/v2/accounts/:accountId/plans',sbResponseBody.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(http.LastHeader);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
v_Type := jResp.StringOf('plan_base.type');
Hosts := jResp.IntOf('plan_base.hosts');
Service_effective_date := jResp.StringOf('plan_base.service_effective_date');
Next_invoice_date := jResp.StringOf('plan_base.next_invoice_date');
Status := jResp.StringOf('plan_base.status');
plan_zoom_roomsType := jResp.StringOf('plan_zoom_rooms.type');
plan_zoom_roomsHosts := jResp.IntOf('plan_zoom_rooms.hosts');
plan_zoom_roomsService_effective_date := jResp.StringOf('plan_zoom_rooms.service_effective_date');
plan_zoom_roomsNext_invoice_date := jResp.StringOf('plan_zoom_rooms.next_invoice_date');
plan_zoom_roomsStatus := jResp.StringOf('plan_zoom_rooms.status');
plan_room_connectorType := jResp.StringOf('plan_room_connector.type');
plan_room_connectorHosts := jResp.IntOf('plan_room_connector.hosts');
plan_room_connectorService_effective_date := jResp.StringOf('plan_room_connector.service_effective_date');
plan_room_connectorNext_invoice_date := jResp.StringOf('plan_room_connector.next_invoice_date');
plan_room_connectorStatus := jResp.StringOf('plan_room_connector.status');
plan_recording := jResp.StringOf('plan_recording');
plan_recording_service_effective_date := jResp.StringOf('plan_recording_service_effective_date');
plan_recording_next_invoice_date := jResp.StringOf('plan_recording_next_invoice_date');
plan_recording_status := jResp.StringOf('plan_recording_status');
plan_audioType := jResp.StringOf('plan_audio.type');
Tollfree_countries := jResp.StringOf('plan_audio.tollfree_countries');
Premium_countries := jResp.StringOf('plan_audio.premium_countries');
Callout_countries := jResp.StringOf('plan_audio.callout_countries');
Ddi_numbers := jResp.IntOf('plan_audio.ddi_numbers');
plan_audioService_effective_date := jResp.StringOf('plan_audio.service_effective_date');
plan_audioNext_invoice_date := jResp.StringOf('plan_audio.next_invoice_date');
plan_audioStatus := jResp.StringOf('plan_audio.status');
Plan_baseType := jResp.StringOf('plan_phone.plan_base.type');
Plan_baseCallout_countries := jResp.StringOf('plan_phone.plan_base.callout_countries');
Plan_baseService_effective_date := jResp.StringOf('plan_phone.plan_base.service_effective_date');
Plan_baseNext_invoice_date := jResp.StringOf('plan_phone.plan_base.next_invoice_date');
Plan_baseStatus := jResp.StringOf('plan_phone.plan_base.status');
i := 0;
count_i := jResp.SizeOfArray('plan_large_meeting');
while i < count_i do
begin
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;
i := 0;
count_i := jResp.SizeOfArray('plan_webinar');
while i < count_i do
begin
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;
i := 0;
count_i := jResp.SizeOfArray('plan_zoom_events');
while i < count_i do
begin
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;
i := 0;
count_i := jResp.SizeOfArray('plan_phone.plan_calling');
while i < count_i do
begin
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;
i := 0;
count_i := jResp.SizeOfArray('plan_phone.plan_number');
while i < count_i do
begin
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;
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": ""
}
]
}
