cURL
curl --request GET \
--url https://api.teamfollowup.ai/api/billing/summary \
--header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.teamfollowup.ai/api/billing/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.teamfollowup.ai/api/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.teamfollowup.ai/api/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 => [
"Authorization: Bearer <token>"
],
]);
$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.teamfollowup.ai/api/billing/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.teamfollowup.ai/api/billing/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/billing/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"generatedAt": "2026-09-14T12:00:00.000Z",
"balance": {
"minutes": 412.5,
"valueUSD": 140.25,
"valueIncludingBonusUSD": 150.45,
"debtMinutes": 0,
"debtUSD": 0,
"status": "ACTIVE",
"currentRatePerMinute": 0.34,
"planCode": "GOLD",
"paymentExempt": false
},
"autoRecharge": {
"enabled": true,
"status": "ENABLED",
"planCode": "GOLD",
"thresholdMinutes": 50,
"blockedReason": null,
"pausedReason": null,
"requiresAction": false,
"recommendedAction": null,
"paymentReviewRequired": false,
"lastSuccessfulRechargeAt": "2026-09-02T08:14:00.000Z",
"lastFailureAt": null,
"lastFailureCode": null,
"nextRetryAt": null
},
"subscription": {
"status": "ACTIVE",
"hasAccess": true,
"trialEnd": null,
"currentPeriodEnd": "2026-10-01T00:00:00.000Z",
"cancelAtPeriodEnd": false,
"pendingPlanCode": null,
"pendingPlanEffectiveAt": null,
"attention": null
},
"pendingPurchase": null,
"spendThisMonth": {
"window": {
"from": "2026-09-01",
"to": "2026-09-14",
"days": 14
},
"calls": 1284,
"minutes": 2310.4,
"callCostUSD": 785.54,
"billedToClientsUSD": 912.3,
"phoneNumbersUSD": 4,
"coAuthorUSD": 3.75,
"totalCostUSD": 793.29
},
"subAccounts": {
"total": 12,
"rebilling": 5,
"low": 1,
"empty": 1,
"needsAttention": [
{
"locationId": "q8LmVt2ZzYQ4pWnKdRb1",
"name": "Harbour Roofing",
"balanceMinutes": 0,
"status": "DEPLETED",
"creditGuardEnabled": true
},
{
"locationId": "rrHDPw5RIR5ULeUlfSAR",
"name": "Bright Dental",
"balanceMinutes": 64.5,
"status": "LOW_BALANCE",
"creditGuardEnabled": false
}
]
},
"pendingCredits": {
"count": 0,
"minutes": 0,
"amountUSD": 0
},
"attention": [
{
"code": "SUB_ACCOUNTS_LOW",
"severity": "WARNING",
"message": "2 rebilled sub-accounts are low or empty."
}
],
"unavailable": []
}
}{
"success": false,
"error": "BadRequest",
"message": "query: Unrecognized key: \"agencyTag\""
}{
"success": false,
"error": "Unauthorized"
}{
"success": false,
"error": "InsufficientScope",
"message": "This API key does not have the required scope.",
"requiredScope": "billing:read"
}{
"success": false,
"error": "TooManyRequests"
}{
"success": false,
"error": "InternalError",
"message": "Could not load billing usage."
}Get billing summary
Where your agency stands, in one call: wallet balance and debt, auto-recharge, your platform subscription, any purchase in progress, spend this month, sub-accounts running low, sub-account payments waiting for credit, and a ranked list of what needs attention.
Each section loads on its own. A section that could not be loaded is null and is named in unavailable, so a null you can see in unavailable means “unknown”, and any other null means “none”.
Allowed customer roles: agency_admin. The agency is the one the credential belongs to; no parameter selects another.
Required API key scope: billing:read.
GET
/
api
/
billing
/
summary
cURL
curl --request GET \
--url https://api.teamfollowup.ai/api/billing/summary \
--header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.teamfollowup.ai/api/billing/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.teamfollowup.ai/api/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.teamfollowup.ai/api/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 => [
"Authorization: Bearer <token>"
],
]);
$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.teamfollowup.ai/api/billing/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.teamfollowup.ai/api/billing/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/billing/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"generatedAt": "2026-09-14T12:00:00.000Z",
"balance": {
"minutes": 412.5,
"valueUSD": 140.25,
"valueIncludingBonusUSD": 150.45,
"debtMinutes": 0,
"debtUSD": 0,
"status": "ACTIVE",
"currentRatePerMinute": 0.34,
"planCode": "GOLD",
"paymentExempt": false
},
"autoRecharge": {
"enabled": true,
"status": "ENABLED",
"planCode": "GOLD",
"thresholdMinutes": 50,
"blockedReason": null,
"pausedReason": null,
"requiresAction": false,
"recommendedAction": null,
"paymentReviewRequired": false,
"lastSuccessfulRechargeAt": "2026-09-02T08:14:00.000Z",
"lastFailureAt": null,
"lastFailureCode": null,
"nextRetryAt": null
},
"subscription": {
"status": "ACTIVE",
"hasAccess": true,
"trialEnd": null,
"currentPeriodEnd": "2026-10-01T00:00:00.000Z",
"cancelAtPeriodEnd": false,
"pendingPlanCode": null,
"pendingPlanEffectiveAt": null,
"attention": null
},
"pendingPurchase": null,
"spendThisMonth": {
"window": {
"from": "2026-09-01",
"to": "2026-09-14",
"days": 14
},
"calls": 1284,
"minutes": 2310.4,
"callCostUSD": 785.54,
"billedToClientsUSD": 912.3,
"phoneNumbersUSD": 4,
"coAuthorUSD": 3.75,
"totalCostUSD": 793.29
},
"subAccounts": {
"total": 12,
"rebilling": 5,
"low": 1,
"empty": 1,
"needsAttention": [
{
"locationId": "q8LmVt2ZzYQ4pWnKdRb1",
"name": "Harbour Roofing",
"balanceMinutes": 0,
"status": "DEPLETED",
"creditGuardEnabled": true
},
{
"locationId": "rrHDPw5RIR5ULeUlfSAR",
"name": "Bright Dental",
"balanceMinutes": 64.5,
"status": "LOW_BALANCE",
"creditGuardEnabled": false
}
]
},
"pendingCredits": {
"count": 0,
"minutes": 0,
"amountUSD": 0
},
"attention": [
{
"code": "SUB_ACCOUNTS_LOW",
"severity": "WARNING",
"message": "2 rebilled sub-accounts are low or empty."
}
],
"unavailable": []
}
}{
"success": false,
"error": "BadRequest",
"message": "query: Unrecognized key: \"agencyTag\""
}{
"success": false,
"error": "Unauthorized"
}{
"success": false,
"error": "InsufficientScope",
"message": "This API key does not have the required scope.",
"requiredScope": "billing:read"
}{
"success": false,
"error": "TooManyRequests"
}{
"success": false,
"error": "InternalError",
"message": "Could not load billing usage."
}⌘I
