Query Usage

GET

usage

Time-windowed usage buckets

curl --request GET \
  --url https://billing.example.com/v1/usage \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/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://billing.example.com/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://billing.example.com/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://billing.example.com/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

{
  "data": [
    {
      "period": "2023-11-07T05:31:56Z",
      "dimension": "api_calls",
      "quantity": 123
    }
  ],
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "granularity": "day"
}

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

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

Aggregates usage events into time buckets (date_trunc by day or month) over an arbitrary window. Use it to power usage charts and consumption dashboards. At least one of subscription_id or customer_id is required. Both may be combined to scope a customer’s usage to a single subscription.

Query Parameters

Parameter	Type	Required	Description
`subscription_id`	string (UUID)	One of these two	Scope to one subscription
`customer_id`	string (UUID)	One of these two	Scope to all of a customer’s subscriptions
`dimension`	string	No	Filter to a single dimension (e.g. `api_calls`)
`from`	string (RFC 3339)	No	Window start, inclusive. Default: `to` minus 30 days
`to`	string (RFC 3339)	No	Window end, exclusive. Default: now
`granularity`	string	No	`day` (default) or `month`

Example Request

curl "https://api.recurso.dev/v1/usage?subscription_id=9a1f...&dimension=api_calls&from=2026-06-01T00:00:00Z&to=2026-07-01T00:00:00Z&granularity=day" \
  -H "Authorization: Bearer $API_KEY"

Response

Buckets are returned in ascending period order, alongside the resolved window (useful when you relied on the defaults). Buckets with no usage are omitted rather than zero-filled.

{
  "data": [
    { "period": "2026-06-01T00:00:00Z", "dimension": "api_calls", "quantity": 1204 },
    { "period": "2026-06-02T00:00:00Z", "dimension": "api_calls", "quantity": 987 },
    { "period": "2026-06-03T00:00:00Z", "dimension": "api_calls", "quantity": 1530 }
  ],
  "from": "2026-06-01T00:00:00Z",
  "to": "2026-07-01T00:00:00Z",
  "granularity": "day"
}

Field	Type	Description
`data[].period`	string	Bucket start (the `date_trunc` of the event timestamps)
`data[].dimension`	string	Usage dimension the bucket aggregates
`data[].quantity`	integer	Total quantity recorded in the bucket
`from` / `to`	string	The resolved query window
`granularity`	string	The resolved bucketing granularity

Errors

Status	Code	When	Fix
`400`	`validation_failed`	Neither `subscription_id` nor `customer_id` given	Scope the query to at least one of the two
`400`	`validation_failed`	`subscription_id` / `customer_id` not valid UUIDs, or `from`/`to` not RFC 3339 timestamps	Fix the formats (e.g. `2026-06-01T00:00:00Z`)
`400`	`validation_failed`	`from` is not before `to`	Swap or widen the window
`400`	`validation_failed`	`granularity` is neither `day` nor `month`	Use one of the two (default `day`)
`401`	`unauthorized`	Missing or invalid API key	Send `Authorization: Bearer $API_KEY`

Errors use the standard envelope — see Errors.

Usage is tenant-scoped through the subscription: you can only ever see buckets for subscriptions that belong to the authenticated tenant.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Query Parameters

subscription_id

string<uuid>

customer_id

string<uuid>

dimension

string

Filter to a single dimension.

from

string<date-time>

Window start (RFC3339, inclusive). Default: to - 30 days.

string<date-time>

Window end (RFC3339, exclusive). Default: now.

granularity

enum<string>

default:day

Available options:

day,

month

Response

Usage buckets plus the resolved window.

data

object[]

Show child attributes

from

string<date-time>

granularity

enum<string>

Available options:

day,

month

Time-windowed usage buckets

curl --request GET \
  --url https://billing.example.com/v1/usage \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/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://billing.example.com/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://billing.example.com/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://billing.example.com/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

{
  "data": [
    {
      "period": "2023-11-07T05:31:56Z",
      "dimension": "api_calls",
      "quantity": 123
    }
  ],
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "granularity": "day"
}

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

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

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Query Parameters

Example Request

Response

Errors

Authorizations

Query Parameters

Response

​Query Parameters

​Example Request

​Response

​Errors

Authorizations

Query Parameters

Response

Query Parameters

Example Request

Response

Errors