Skip to main content
GET
/
billing
/
summary
Get billing summary
curl --request GET \
  --url https://api.superserve.ai/billing/summary \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.superserve.ai/billing/summary"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.superserve.ai/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.superserve.ai/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.superserve.ai/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))

}
HttpResponse<String> response = Unirest.get("https://api.superserve.ai/billing/summary")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.superserve.ai/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
{
  "current_charges_usd": 123,
  "credits_applied_usd": 123,
  "credits_remaining_usd": 123,
  "expected_invoice_amount_usd": 123,
  "cost_breakdown_usd": {
    "compute": 123,
    "memory": 123,
    "storage": 123
  },
  "billing_period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "pricing_tier": {
    "plan_key": "payg",
    "plan_name": "Pay-as-you-go",
    "currency": "USD"
  },
  "calculated_at": "2023-11-07T05:31:56Z"
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Response

Current billing period financial summary

​
current_charges_usd
number<double>
required

Current period charges before credits.

​
credits_applied_usd
number<double>
required

Credits applied against the current period charges.

​
credits_remaining_usd
number<double>
required

Credits still available after applying current period charges.

​
expected_invoice_amount_usd
number<double>
required

Expected invoice amount after credits.

​
cost_breakdown_usd
object
required
​
billing_period
object
required
​
pricing_tier
object
required
​
calculated_at
string<date-time>
required

Timestamp when this live billing summary was calculated.