Chilkat Online Tools

DataFlex / Zoom API / Get billing reports

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sId
    String sStart_date
    String sEnd_date
    String sTotal_amount
    String sTax_amount
    Integer iV_type
    String sV_currency
    Integer i
    Integer iCount_i
    String sTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComQuickGetSb Of hoHttp "https://api.zoom.us/v2/report/billing" vSbResponseBody To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComLastStatus Of hoHttp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComLastHeader Of hoHttp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_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

    Get ComStringOf Of hoJResp "currency" To sV_currency
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "billing_reports" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "billing_reports[i].id" To sId
        Get ComStringOf Of hoJResp "billing_reports[i].start_date" To sStart_date
        Get ComStringOf Of hoJResp "billing_reports[i].end_date" To sEnd_date
        Get ComStringOf Of hoJResp "billing_reports[i].total_amount" To sTotal_amount
        Get ComStringOf Of hoJResp "billing_reports[i].tax_amount" To sTax_amount
        Get ComIntOf Of hoJResp "billing_reports[i].type" To iV_type
        Move (i + 1) To i
    Loop



End_Procedure

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": ""
    }
  ]
}