Chilkat Online Tools

Go / Zoom API / Get billing reports

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.SetAuthToken("<access_token>")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://api.zoom.us/v2/report/billing",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    // 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

    var id *string = new(string)
    var start_date *string = new(string)
    var end_date *string = new(string)
    var total_amount *string = new(string)
    var tax_amount *string = new(string)
    var v_type int

    v_currency := jResp.StringOf("currency")
    i := 0
    count_i := jResp.SizeOfArray("billing_reports")
    for i < count_i {
        jResp.SetI(i)
        id = jResp.StringOf("billing_reports[i].id")
        start_date = jResp.StringOf("billing_reports[i].start_date")
        end_date = jResp.StringOf("billing_reports[i].end_date")
        total_amount = jResp.StringOf("billing_reports[i].total_amount")
        tax_amount = jResp.StringOf("billing_reports[i].tax_amount")
        v_type = jResp.IntOf("billing_reports[i].type")
        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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