Billable usage

curl --request GET \
  --url https://api.farthing.ai/v1/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.farthing.ai/v1/usage")

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

{
  "from": "2026-07-01T00:00:00.000Z",
  "to": "2026-07-29T09:14:31.190Z",
  "completedCheckouts": 37,
  "byDay": [
    {
      "day": "2026-07-27",
      "count": 12
    },
    {
      "day": "2026-07-28",
      "count": 25
    }
  ],
  "merchandiseVolume": [
    {
      "currency": "USD",
      "amount": "1482.55"
    },
    {
      "currency": "GBP",
      "amount": "96.00"
    }
  ]
}

Usage

Billable usage

Completed checkouts only. Attempts are never metered — charging for attempts would mean earning more when the agent fails, which is backwards for a product whose entire problem is reliability.

The default window is the current calendar month (UTC), which is the unit tenants are billed in.

Requires the usage.read scope.

A subject-bound key cannot call this. Billing is between us and the tenant; an end user’s key reading the account’s total spend and order volume would be a leak between your own customers. 403.

GET

usage

Billable usage

curl --request GET \
  --url https://api.farthing.ai/v1/usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.farthing.ai/v1/usage")

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

{
  "from": "2026-07-01T00:00:00.000Z",
  "to": "2026-07-29T09:14:31.190Z",
  "completedCheckouts": 37,
  "byDay": [
    {
      "day": "2026-07-27",
      "count": 12
    },
    {
      "day": "2026-07-28",
      "count": 25
    }
  ],
  "merchandiseVolume": [
    {
      "currency": "USD",
      "amount": "1482.55"
    },
    {
      "currency": "GBP",
      "amount": "96.00"
    }
  ]
}

Authorizations

Authorization

string

header

required

Authorization: Bearer ck_test_… or ck_live_…. There is no other auth scheme — no query-string keys, no request signing, no OAuth.

Query Parameters

from

string<date-time>

Inclusive start. Any Date-parseable string. Defaults to the first instant of the current UTC month.

string<date-time>

Exclusive end. Defaults to now.

Response

The summary for the window.

from

string<date-time>

required

string<date-time>

required

completedCheckouts

integer

required

The billable number.

byDay

object[]

required

Completed checkouts per UTC day, cut at UTC midnight to match from, to and every other timestamp the API returns — the bucket a checkout lands in never depends on the server's timezone or yours. Days with no completions are omitted, not zero-filled.

Show child attributes

merchandiseVolume

Money · object[]

required

Gross merchandise volume by currency. Reporting only — billing is per completed checkout, not a percentage.

Show child attributes

Revoke an API key The caller's workspace

⌘I

Reference

Endpoints

Billable usage

Authorizations

Query Parameters

Response