Get billing summary - Ticksupply API

GET

billing

summary

Python (ticksupply library)

# pip install ticksupply
from ticksupply import Client

client = Client(api_key="<api-key>")
summary = client.billing.get_summary()
print(summary)

// cargo add ticksupply
// cargo add tokio --features full
use ticksupply::Client;

#[tokio::main]
async fn main() -> ticksupply::Result<()> {
    let client = Client::with_api_key("<api-key>")?;
    let summary = client.billing().summary().await?;
    println!("{summary:#?}");
    Ok(())
}

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

fetch('https://api.ticksupply.com/v1/billing/summary', 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.ticksupply.com/v1/billing/summary",
  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-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.ticksupply.com/v1/billing/summary"

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

	req.Header.Add("X-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.ticksupply.com/v1/billing/summary")

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

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

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

{
  "access_status": "ACTIVE",
  "usage": {
    "extra_stream_minutes_total": 0,
    "export_gb_total": "12.5",
    "export_gb_extra": 0
  },
  "grace_until": "2026-05-01T00:00:00Z",
  "plan_code": "starter",
  "current_period_end": "2026-05-12T23:34:19Z"
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "request_timeout",
    "message": "Request exceeded 10s deadline"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after 30 seconds."
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Authorizations

X-Api-Key

string

header

required

Your API key. Get one from the dashboard at https://app.ticksupply.com/api-keys

Response

Billing summary for the authenticated account.

access_status

enum<string>

required

Current access state for the account.

ACTIVE: Full access, payment current.
TRIALING: Full access, trial-plan caps enforced (no overage).
GRACE: Limited access, payment overdue but within grace period. grace_until will be set.
SUSPENDED: No access, payment overdue beyond grace period.
NONE: Account has no active subscription.

Available options:

ACTIVE,

TRIALING,

GRACE,

SUSPENDED,

NONE

Example:

"ACTIVE"

usage

object

required

Usage totals for the current billing period.

Show child attributes

grace_until

string<date-time> | null

When the grace period ends. Present only when access_status is GRACE.

Example:

"2026-05-01T00:00:00Z"

plan_code

string | null

Plan identifier (e.g., trial, starter, pro). Null if the account has no plan.

Example:

"starter"

current_period_end

string<date-time> | null

End of the current billing period. Null if the account has no active subscription.

Example:

"2026-05-12T23:34:19Z"

Last modified on April 17, 2026

Python (ticksupply library)

# pip install ticksupply
from ticksupply import Client

client = Client(api_key="<api-key>")
summary = client.billing.get_summary()
print(summary)

// cargo add ticksupply
// cargo add tokio --features full
use ticksupply::Client;

#[tokio::main]
async fn main() -> ticksupply::Result<()> {
    let client = Client::with_api_key("<api-key>")?;
    let summary = client.billing().summary().await?;
    println!("{summary:#?}");
    Ok(())
}

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

fetch('https://api.ticksupply.com/v1/billing/summary', 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.ticksupply.com/v1/billing/summary",
  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-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.ticksupply.com/v1/billing/summary"

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

	req.Header.Add("X-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.ticksupply.com/v1/billing/summary")

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

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

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

{
  "access_status": "ACTIVE",
  "usage": {
    "extra_stream_minutes_total": 0,
    "export_gb_total": "12.5",
    "export_gb_extra": 0
  },
  "grace_until": "2026-05-01T00:00:00Z",
  "plan_code": "starter",
  "current_period_end": "2026-05-12T23:34:19Z"
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "request_timeout",
    "message": "Request exceeded 10s deadline"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after 30 seconds."
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}