Skip to main content
GET
/
api
/
v1
/
analytics
/
summary
Spend summary
curl --request GET \
  --url https://your-site.example/api/v1/analytics/summary \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://your-site.example/api/v1/analytics/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your-site.example/api/v1/analytics/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://your-site.example/api/v1/analytics/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://your-site.example/api/v1/analytics/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://your-site.example/api/v1/analytics/summary")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://your-site.example/api/v1/analytics/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
{ "summary": { "asOf": "2023-11-07T05:31:56Z", "horizonDays": 123, "counts": { "total": 123, "active": 123, "paused": 123, "cancelled": 123 }, "byCurrency": [ { "currency": "<string>", "activeSubscriptions": 123, "monthlyTotal": 123, "yearlyTotal": 123 } ], "byCategory": [ { "category": "<string>", "activeSubscriptions": 123, "monthlyTotalsByCurrency": {} } ], "upcomingRenewals": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "category": "<string>", "amount": 123, "currency": "<string>", "nextPaymentDate": "2026-06-01", "daysUntilRenewal": 123 } ] }, "requestId": "<string>" }

Authorizations

Authorization
string
header
default:subm_your_key_here
required

Developer API key generated in the app. Keys carry scopes; a read key can call list, get, analytics, and audit endpoints, while a write key additionally allows create, update, cancel, pause, resume, and delete.

Query Parameters

horizonDays
integer
default:30

Window in days for the upcomingRenewals list (default 30).

Required range: 1 <= x <= 365

Response

Spend summary computed.

summary
object
required
requestId
string
required