Get balance statement

GET

billing

balance

statement

curl --request GET \
  --url https://api.axilio.ai/api/v1/billing/balance/statement \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/billing/balance/statement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/billing/balance/statement",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/billing/balance/statement"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/billing/balance/statement")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "added_microdollars": 123,
  "ending_balance_microdollars": 123,
  "expired_microdollars": 123,
  "other_microdollars": 123,
  "period_end_at": "2023-11-07T05:31:56Z",
  "period_start_at": "2023-11-07T05:31:56Z",
  "refunded_microdollars": 123,
  "starting_balance_microdollars": 123,
  "usage": [
    {
      "amount_microdollars": 123,
      "count": 123,
      "product": "<string>"
    }
  ]
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Query Parameters

period_start_at

string<date-time>

required

start of the period (RFC 3339)

period_end_at

string<date-time>

required

end of the period, exclusive (RFC 3339)

Response

The organization's balance over a period, like a bank statement: where it started, what moved it, and where it ended. The lines add up: starting + added + each usage amount + refunded + expired + other = ending.

added_microdollars

integer<int64>

required

Credit added in microdollars: top-ups, auto-recharge, plan credit and adjustments.

ending_balance_microdollars

integer<int64>

required

Balance in microdollars at the end of the period.

expired_microdollars

integer<int64>

required

Purchased credit that expired and plan credit that lapsed, in microdollars (zero or negative).

other_microdollars

integer<int64>

required

Negative adjustments and balance corrections, in microdollars.

period_end_at

string<date-time>

required

End of the period (exclusive).

period_start_at

string<date-time>

required

Start of the period.

refunded_microdollars

integer<int64>

required

Credit taken back by refunds and chargebacks, net of chargebacks won, in microdollars. Usually negative; positive when chargebacks won in the period exceed what was taken back.

starting_balance_microdollars

integer<int64>

required

Balance in microdollars at the start of the period.

usage

object[] | null

required

What each product used in the period, costliest first.

Show child attributes

Get balance statement

curl --request GET \
  --url https://api.axilio.ai/api/v1/billing/balance/statement \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/billing/balance/statement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/billing/balance/statement",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/billing/balance/statement"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/billing/balance/statement")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "added_microdollars": 123,
  "ending_balance_microdollars": 123,
  "expired_microdollars": 123,
  "other_microdollars": 123,
  "period_end_at": "2023-11-07T05:31:56Z",
  "period_start_at": "2023-11-07T05:31:56Z",
  "refunded_microdollars": 123,
  "starting_balance_microdollars": 123,
  "usage": [
    {
      "amount_microdollars": 123,
      "count": 123,
      "product": "<string>"
    }
  ]
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Argus API

Get balance statement

Authorizations

Query Parameters

Response