SQL Server / Zoom API / Get billing reports
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.zoom.us/v2/report/billing', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "billing_reports": [
-- {
-- "id": "indfhgfhfho",
-- "start_date": "2020-01-01",
-- "end_date": "2020-01-31",
-- "total_amount": "1500",
-- "tax_amount": "25",
-- "type": 0
-- },
-- {
-- "id": "dfhjkdgsds",
-- "start_date": "2019-12-24",
-- "end_date": "2020-01-23",
-- "total_amount": "2000",
-- "tax_amount": "38",
-- "type": 1
-- }
-- ],
-- "currency": "USD"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @start_date nvarchar(4000)
DECLARE @end_date nvarchar(4000)
DECLARE @total_amount nvarchar(4000)
DECLARE @tax_amount nvarchar(4000)
DECLARE @v_type int
DECLARE @v_currency nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_currency OUT, 'currency'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'billing_reports'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'billing_reports[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @start_date OUT, 'billing_reports[i].start_date'
EXEC sp_OAMethod @jResp, 'StringOf', @end_date OUT, 'billing_reports[i].end_date'
EXEC sp_OAMethod @jResp, 'StringOf', @total_amount OUT, 'billing_reports[i].total_amount'
EXEC sp_OAMethod @jResp, 'StringOf', @tax_amount OUT, 'billing_reports[i].tax_amount'
EXEC sp_OAMethod @jResp, 'IntOf', @v_type OUT, 'billing_reports[i].type'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/billing
Postman Collection Item JSON
{
"name": "Get billing reports",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/billing",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"billing"
]
},
"description": "Get department billing reports of a Zoom account.\n\n**Prerequisites:**<br>\n* Pro or a higher account with Department Billing option enabled. Contact Zoom Support team for details.\n\n**Scopes:** `report:read:admin`, `report:master`\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nBilling report returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/billing",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"billing"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"billing_reports\": [\n {\n \"id\": \"indfhgfhfho\",\n \"start_date\": \"2020-01-01\",\n \"end_date\": \"2020-01-31\",\n \"total_amount\": \"1500\",\n \"tax_amount\": \"25\",\n \"type\": 0\n },\n {\n \"id\": \"dfhjkdgsds\",\n \"start_date\": \"2019-12-24\",\n \"end_date\": \"2020-01-23\",\n \"total_amount\": \"2000\",\n \"tax_amount\": \"38\",\n \"type\": 1\n }\n ],\n \"currency\": \"USD\"\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `200`<br> No permission.\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/billing",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"billing"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
