Foxpro / Zoom API / Get account plan information
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_type
LOCAL lnHosts
LOCAL lcService_effective_date
LOCAL lcNext_invoice_date
LOCAL lcStatus
LOCAL lcV_Type
LOCAL lnHosts
LOCAL lcService_effective_date
LOCAL lcNext_invoice_date
LOCAL lcStatus
LOCAL lcPlan_zoom_roomsType
LOCAL lnPlan_zoom_roomsHosts
LOCAL lcPlan_zoom_roomsService_effective_date
LOCAL lcPlan_zoom_roomsNext_invoice_date
LOCAL lcPlan_zoom_roomsStatus
LOCAL lcPlan_room_connectorType
LOCAL lnPlan_room_connectorHosts
LOCAL lcPlan_room_connectorService_effective_date
LOCAL lcPlan_room_connectorNext_invoice_date
LOCAL lcPlan_room_connectorStatus
LOCAL lcPlan_recording
LOCAL lcPlan_recording_service_effective_date
LOCAL lcPlan_recording_next_invoice_date
LOCAL lcPlan_recording_status
LOCAL lcPlan_audioType
LOCAL lcTollfree_countries
LOCAL lcPremium_countries
LOCAL lcCallout_countries
LOCAL lnDdi_numbers
LOCAL lcPlan_audioService_effective_date
LOCAL lcPlan_audioNext_invoice_date
LOCAL lcPlan_audioStatus
LOCAL lcPlan_baseType
LOCAL lcPlan_baseCallout_countries
LOCAL lcPlan_baseService_effective_date
LOCAL lcPlan_baseNext_invoice_date
LOCAL lcPlan_baseStatus
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.zoom.us/v2/accounts/:accountId/plans",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
lcV_Type = loJResp.StringOf("plan_base.type")
lnHosts = loJResp.IntOf("plan_base.hosts")
lcService_effective_date = loJResp.StringOf("plan_base.service_effective_date")
lcNext_invoice_date = loJResp.StringOf("plan_base.next_invoice_date")
lcStatus = loJResp.StringOf("plan_base.status")
lcPlan_zoom_roomsType = loJResp.StringOf("plan_zoom_rooms.type")
lnPlan_zoom_roomsHosts = loJResp.IntOf("plan_zoom_rooms.hosts")
lcPlan_zoom_roomsService_effective_date = loJResp.StringOf("plan_zoom_rooms.service_effective_date")
lcPlan_zoom_roomsNext_invoice_date = loJResp.StringOf("plan_zoom_rooms.next_invoice_date")
lcPlan_zoom_roomsStatus = loJResp.StringOf("plan_zoom_rooms.status")
lcPlan_room_connectorType = loJResp.StringOf("plan_room_connector.type")
lnPlan_room_connectorHosts = loJResp.IntOf("plan_room_connector.hosts")
lcPlan_room_connectorService_effective_date = loJResp.StringOf("plan_room_connector.service_effective_date")
lcPlan_room_connectorNext_invoice_date = loJResp.StringOf("plan_room_connector.next_invoice_date")
lcPlan_room_connectorStatus = loJResp.StringOf("plan_room_connector.status")
lcPlan_recording = loJResp.StringOf("plan_recording")
lcPlan_recording_service_effective_date = loJResp.StringOf("plan_recording_service_effective_date")
lcPlan_recording_next_invoice_date = loJResp.StringOf("plan_recording_next_invoice_date")
lcPlan_recording_status = loJResp.StringOf("plan_recording_status")
lcPlan_audioType = loJResp.StringOf("plan_audio.type")
lcTollfree_countries = loJResp.StringOf("plan_audio.tollfree_countries")
lcPremium_countries = loJResp.StringOf("plan_audio.premium_countries")
lcCallout_countries = loJResp.StringOf("plan_audio.callout_countries")
lnDdi_numbers = loJResp.IntOf("plan_audio.ddi_numbers")
lcPlan_audioService_effective_date = loJResp.StringOf("plan_audio.service_effective_date")
lcPlan_audioNext_invoice_date = loJResp.StringOf("plan_audio.next_invoice_date")
lcPlan_audioStatus = loJResp.StringOf("plan_audio.status")
lcPlan_baseType = loJResp.StringOf("plan_phone.plan_base.type")
lcPlan_baseCallout_countries = loJResp.StringOf("plan_phone.plan_base.callout_countries")
lcPlan_baseService_effective_date = loJResp.StringOf("plan_phone.plan_base.service_effective_date")
lcPlan_baseNext_invoice_date = loJResp.StringOf("plan_phone.plan_base.next_invoice_date")
lcPlan_baseStatus = loJResp.StringOf("plan_phone.plan_base.status")
i = 0
lnCount_i = loJResp.SizeOfArray("plan_large_meeting")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("plan_large_meeting[i].type")
lnHosts = loJResp.IntOf("plan_large_meeting[i].hosts")
lcService_effective_date = loJResp.StringOf("plan_large_meeting[i].service_effective_date")
lcNext_invoice_date = loJResp.StringOf("plan_large_meeting[i].next_invoice_date")
lcStatus = loJResp.StringOf("plan_large_meeting[i].status")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("plan_webinar")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("plan_webinar[i].type")
lnHosts = loJResp.IntOf("plan_webinar[i].hosts")
lcService_effective_date = loJResp.StringOf("plan_webinar[i].service_effective_date")
lcNext_invoice_date = loJResp.StringOf("plan_webinar[i].next_invoice_date")
lcStatus = loJResp.StringOf("plan_webinar[i].status")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("plan_zoom_events")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("plan_zoom_events[i].type")
lnHosts = loJResp.IntOf("plan_zoom_events[i].hosts")
lcService_effective_date = loJResp.StringOf("plan_zoom_events[i].service_effective_date")
lcNext_invoice_date = loJResp.StringOf("plan_zoom_events[i].next_invoice_date")
lcStatus = loJResp.StringOf("plan_zoom_events[i].status")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("plan_phone.plan_calling")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("plan_phone.plan_calling[i].type")
lnHosts = loJResp.IntOf("plan_phone.plan_calling[i].hosts")
lcService_effective_date = loJResp.StringOf("plan_phone.plan_calling[i].service_effective_date")
lcNext_invoice_date = loJResp.StringOf("plan_phone.plan_calling[i].next_invoice_date")
lcStatus = loJResp.StringOf("plan_phone.plan_calling[i].status")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("plan_phone.plan_number")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("plan_phone.plan_number[i].type")
lnHosts = loJResp.IntOf("plan_phone.plan_number[i].hosts")
lcService_effective_date = loJResp.StringOf("plan_phone.plan_number[i].service_effective_date")
lcNext_invoice_date = loJResp.StringOf("plan_phone.plan_number[i].next_invoice_date")
lcStatus = loJResp.StringOf("plan_phone.plan_number[i].status")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
