Android / Zoom API / List billing invoices
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
CkJsonObject queryParams = new CkJsonObject();
queryParams.UpdateString("from","1989-05-07");
queryParams.UpdateString("to","1989-05-07");
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>");
CkHttpResponse resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/accounts/:accountId/billing/invoices",queryParams);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "invoices": [
// {
// "id": "2c92c12348d07e0580",
// "invoice_number": "S8INsdf4534000001",
// "total_amount": 2039,
// "tax_amount": 0,
// "balance": 2039,
// "due_date": "2020-08-07",
// "invoice_date": "2020-08-07",
// "target_date": "2020-08-07",
// "status": "Draft"
// }
// ],
// "currency": "USD"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
String id;
String invoice_number;
int total_amount;
int tax_amount;
int balance;
String due_date;
String invoice_date;
String target_date;
String status;
String v_currency = jResp.stringOf("currency");
int i = 0;
int count_i = jResp.SizeOfArray("invoices");
while (i < count_i) {
jResp.put_I(i);
id = jResp.stringOf("invoices[i].id");
invoice_number = jResp.stringOf("invoices[i].invoice_number");
total_amount = jResp.IntOf("invoices[i].total_amount");
tax_amount = jResp.IntOf("invoices[i].tax_amount");
balance = jResp.IntOf("invoices[i].balance");
due_date = jResp.stringOf("invoices[i].due_date");
invoice_date = jResp.stringOf("invoices[i].invoice_date");
target_date = jResp.stringOf("invoices[i].target_date");
status = jResp.stringOf("invoices[i].status");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/billing/invoices
Postman Collection Item JSON
{
"name": "List billing invoices",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/billing/invoices?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"billing",
"invoices"
],
"query": [
{
"key": "from",
"value": "1989-05-07",
"description": "Start date for the invoice query in `yyyy-mm-dd` format. The date range defined by the “from” and “to” parameters should not exceed one year. The range defined should fall within the past three years.\n"
},
{
"key": "to",
"value": "1989-05-07",
"description": "End date for the invoice query in `yyyy-mm-dd` format"
}
],
"variable": [
{
"key": "accountId"
}
]
},
"description": "List [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e) of a Zoom account.\n\nTo list a regular Zoom account's invoices or a master account's invoices, provide `me` as the value of the `accountId` path parameter. To list a sub account's invoices, provide the account ID of the sub account in the `accountId` path parameter. \n\n**Prerequisites:**\n* Account must be enrolled in Pro or a higher plan.<br>\n\n**Scope**:`billing:master`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Additional Rate Limit:** You can make **one** API request per account(`accountId`) every **five** minutes until the daily limit is reached. This API has a daily limit of **6** requests per account(`accountId`)."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nAccount billing invoice information returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/billing/invoices?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"billing",
"invoices"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
}
],
"variable": [
{
"key": "accountId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"invoices\": [\n {\n \"id\": \"2c92c12348d07e0580\",\n \"invoice_number\": \"S8INsdf4534000001\",\n \"total_amount\": 2039,\n \"tax_amount\": 0,\n \"balance\": 2039,\n \"due_date\": \"2020-08-07\",\n \"invoice_date\": \"2020-08-07\",\n \"target_date\": \"2020-08-07\",\n \"status\": \"Draft\"\n }\n ],\n \"currency\": \"USD\"\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `200`<br>\nOnly available for Paid account: {subAccountId}.\n**Error Code:** `2001`<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/billing/invoices?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"billing",
"invoices"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
}
],
"variable": [
{
"key": "accountId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
