Billing

Get timezone-aware billing usage chart buckets

Returns zero-filled local-calendar buckets for the half-open [start,end) range. timezone must be an IANA timezone name (for example, America/Chicago). The response is limited to 400 buckets. Every request requires the authenticated team’s billing:read permission. billed_total_usd is gross CPU and memory usage cost before credits, taxes, or payments; storage cost_usd is an informational equivalent while storage remains tracked-only and is excluded from that total.

GET

billing

usage-series

curl --request GET \
  --url https://api.superserve.ai/billing/usage-series \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.superserve.ai/billing/usage-series', 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/usage-series",
  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/usage-series"

	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.superserve.ai/billing/usage-series")

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

{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "granularity": "hour",
  "timezone": "<string>",
  "buckets": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "cpu": {
        "usage": 123,
        "cost_usd": 123,
        "tracked": true,
        "billable": true
      },
      "memory": {
        "usage": 123,
        "cost_usd": 123,
        "tracked": true,
        "billable": true
      },
      "storage": {
        "usage": 123,
        "cost_usd": 123,
        "tracked": true,
        "billable": true
      },
      "billed_total_usd": 123
    }
  ]
}

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

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Query Parameters

start

string<date-time>

required

Absolute range start (inclusive).

end

string<date-time>

required

Absolute range end (exclusive); must be after start.

granularity

enum<string>

required

Local calendar bucket size. Weeks start Monday at 00:00.

Available options:

hour,

day,

week,

month

timezone

string

required

IANA timezone used for calendar boundaries and DST rules.

Example:

"America/Chicago"

Response

Usage series

Ordered, continuous series of at most 400 timezone-aware buckets.

start

string<date-time>

required

end

string<date-time>

required

granularity

enum<string>

required

Available options:

hour,

day,

week,

month

timezone

string

required

buckets

object[]

required

Show child attributes

Get timezone-aware billing usage chart buckets

curl --request GET \
  --url https://api.superserve.ai/billing/usage-series \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.superserve.ai/billing/usage-series', 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/usage-series",
  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/usage-series"

	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.superserve.ai/billing/usage-series")

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

{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "granularity": "hour",
  "timezone": "<string>",
  "buckets": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "cpu": {
        "usage": 123,
        "cost_usd": 123,
        "tracked": true,
        "billable": true
      },
      "memory": {
        "usage": 123,
        "cost_usd": 123,
        "tracked": true,
        "billable": true
      },
      "storage": {
        "usage": 123,
        "cost_usd": 123,
        "tracked": true,
        "billable": true
      },
      "billed_total_usd": 123
    }
  ]
}

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

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Sandboxes

Exec

Files

Templates

Secrets

Billing

Team Management

Activity

Get timezone-aware billing usage chart buckets

Authorizations

Query Parameters

Response