Get current plan

GET

billing

subscription

Get current plan

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

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

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

{
  "balance_display": "<string>",
  "balance_microdollars": 123,
  "billing_cycle": "monthly",
  "cancel_at_period_end": true,
  "current_period_end": "2023-11-07T05:31:56Z",
  "current_period_start": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "included_balance_display": "<string>",
  "included_balance_microdollars": 123,
  "max_concurrent_runs": 123,
  "monthly_price": 123,
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan_name": "<string>",
  "price_per_second_microdollars": 123,
  "status": "active",
  "yearly_price": 123,
  "canceled_at": "2023-11-07T05:31:56Z",
  "pending_downgrade_effective_date": "2023-11-07T05:31:56Z",
  "pending_downgrade_plan_id": "<string>",
  "trial_end": "2023-11-07T05:31:56Z"
}

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

Response

Full subscription record returned by subscription endpoints.

balance_display

string

required

Formatted balance string (e.g., '$12.50').

balance_microdollars

integer<int64>

required

Current account balance in microdollars.

billing_cycle

enum<string>

required

Billing frequency for this subscription.

Available options:

monthly,

yearly

cancel_at_period_end

boolean

required

Whether the subscription cancels at the end of the period.

current_period_end

string<date-time>

required

End of the current billing period.

current_period_start

string<date-time>

required

Start of the current billing period.

string<uuid>

required

Subscription identifier.

included_balance_display

string

required

Formatted included balance (e.g., '$10.00').

included_balance_microdollars

integer<int64>

required

Balance granted each billing period in microdollars.

max_concurrent_runs

integer<int64>

required

Maximum simultaneous runs allowed on this plan.

monthly_price

number<double>

required

Monthly plan price in dollars.

plan_id

string<uuid>

required

Billing plan's identifier.

plan_name

string

required

Customer-facing plan name.

price_per_second_microdollars

integer<int64>

required

Per-second compute charge in microdollars.

status

enum<string>

required

Current lifecycle state of the subscription.

Available options:

active,

canceled,

past_due,

trialing,

incomplete,

incomplete_expired,

unpaid

yearly_price

number<double>

required

Annual plan price in dollars.

canceled_at

string<date-time>

Timestamp when the subscription was canceled.

pending_downgrade_effective_date

string<date-time>

When the pending downgrade takes effect.

pending_downgrade_plan_id

string

Plan ID of a scheduled future downgrade.

trial_end

string<date-time>

Timestamp when the free trial ends.

Get current plan

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

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

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

{
  "balance_display": "<string>",
  "balance_microdollars": 123,
  "billing_cycle": "monthly",
  "cancel_at_period_end": true,
  "current_period_end": "2023-11-07T05:31:56Z",
  "current_period_start": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "included_balance_display": "<string>",
  "included_balance_microdollars": 123,
  "max_concurrent_runs": 123,
  "monthly_price": 123,
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan_name": "<string>",
  "price_per_second_microdollars": 123,
  "status": "active",
  "yearly_price": 123,
  "canceled_at": "2023-11-07T05:31:56Z",
  "pending_downgrade_effective_date": "2023-11-07T05:31:56Z",
  "pending_downgrade_plan_id": "<string>",
  "trial_end": "2023-11-07T05:31:56Z"
}

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

Get current plan

Authorizations

Response