List billing history

GET

billing

history

curl --request GET \
  --url https://api.axilio.ai/api/v1/billing/history \
  --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/history', 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/history",
  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/history"

	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/history")

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

{
  "items": [
    {
      "amount_cents": 123,
      "amount_dollars": 123,
      "billing_cycle": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "formatted_amount": "<string>",
      "id": "<string>",
      "invoice_date": "2023-11-07T05:31:56Z",
      "invoice_number": "<string>",
      "plan_name": "<string>",
      "status": "paid",
      "due_date": "2023-11-07T05:31:56Z",
      "hosted_invoice_url": "<string>",
      "invoice_pdf_url": "<string>",
      "paid_at": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

{
  "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

limit

integer<int64>

default:50

max items per page

Required range: 1 <= x <= 100

offset

integer<int64>

default:0

pagination offset

Required range: x >= 0

string

free-text search across invoice number/description

billing_cycle

string

filter by billing cycle

sort_by

string

column to sort by

sort_order

string

asc or desc

status

string

invoice status filter (lowercase)

date_from

string

RFC3339 lower bound for invoice_date

date_to

string

RFC3339 upper bound for invoice_date (with date_from = an exact calendar month)

plan_name

string

filter by plan name

phone_id

string

filter to invoices for a dedicated phone

Response

One page of billing history items, using the API's standard list envelope (items, total, limit, offset).

items

object[] | null

required

Page of invoice records.

Show child attributes

limit

integer<int64>

required

Page size used for this response.

offset

integer<int64>

required

Pagination offset used for this response.

total

integer<int64>

required

Total number of invoices matching the query.

List billing history

curl --request GET \
  --url https://api.axilio.ai/api/v1/billing/history \
  --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/history', 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/history",
  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/history"

	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/history")

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

{
  "items": [
    {
      "amount_cents": 123,
      "amount_dollars": 123,
      "billing_cycle": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "formatted_amount": "<string>",
      "id": "<string>",
      "invoice_date": "2023-11-07T05:31:56Z",
      "invoice_number": "<string>",
      "plan_name": "<string>",
      "status": "paid",
      "due_date": "2023-11-07T05:31:56Z",
      "hosted_invoice_url": "<string>",
      "invoice_pdf_url": "<string>",
      "paid_at": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

{
  "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

Vision API

List billing history

Authorizations

Query Parameters

Response