Retrieve customer current and projected usage
curl --request GET \
--url https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_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.getlago.com/api/v1/customers/{external_customer_id}/projected_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.getlago.com/api/v1/customers/{external_customer_id}/projected_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))
}HttpResponse<String> response = Unirest.get("https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_usage")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_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{
"customer_projected_usage": {
"from_datetime": "2022-07-01T00:00:00Z",
"to_datetime": "2022-07-31T23:59:59Z",
"issuing_date": "2022-08-01",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"currency": "EUR",
"amount_cents": 123,
"projected_amount_cents": 256,
"taxes_amount_cents": 200,
"total_amount_cents": 123,
"charges_usage": [
{
"units": "1.0",
"projected_units": "2.0",
"events_count": 10,
"amount_cents": 123,
"projected_amount_cents": 256,
"amount_currency": "EUR",
"charge": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"charge_model": "dynamic",
"invoice_display_name": "Setup"
},
"billable_metric": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"name": "Storage",
"code": "storage",
"aggregation_type": "sum_agg"
},
"grouped_usage": [
{
"amount_cents": 1000,
"projected_amount_cents": 2000,
"events_count": 10,
"units": "0.9",
"projected_units": "1.8",
"grouped_by": {},
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"filters": [
{
"units": "0.9",
"projected_units": "1.8",
"amount_cents": 1000,
"projected_amount_cents": 2000,
"events_count": 10,
"values": {
"region": [
"us-east-1"
]
},
"invoice_display_name": "AWS eu-east-1",
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
],
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
],
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"filters": [
{
"units": "0.9",
"projected_units": "1.8",
"amount_cents": 1000,
"projected_amount_cents": 2000,
"events_count": 10,
"values": {
"region": [
"us-east-1"
]
},
"invoice_display_name": "AWS eu-east-1",
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
],
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
]
}
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 403,
"error": "Forbidden",
"code": "feature_unavailable"
}{
"status": 404,
"error": "Not Found",
"code": "object_not_found"
}{
"status": 405,
"error": "Method Not Allowed",
"code": "not_allowed"
}Customer usage
Retrieve projected usage
Retrieve real-time projected usage data for the current open billing period.
GET
/
customers
/
{external_customer_id}
/
projected_usage
Retrieve customer current and projected usage
curl --request GET \
--url https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_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.getlago.com/api/v1/customers/{external_customer_id}/projected_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.getlago.com/api/v1/customers/{external_customer_id}/projected_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))
}HttpResponse<String> response = Unirest.get("https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_usage")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getlago.com/api/v1/customers/{external_customer_id}/projected_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{
"customer_projected_usage": {
"from_datetime": "2022-07-01T00:00:00Z",
"to_datetime": "2022-07-31T23:59:59Z",
"issuing_date": "2022-08-01",
"lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"currency": "EUR",
"amount_cents": 123,
"projected_amount_cents": 256,
"taxes_amount_cents": 200,
"total_amount_cents": 123,
"charges_usage": [
{
"units": "1.0",
"projected_units": "2.0",
"events_count": 10,
"amount_cents": 123,
"projected_amount_cents": 256,
"amount_currency": "EUR",
"charge": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"charge_model": "dynamic",
"invoice_display_name": "Setup"
},
"billable_metric": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"name": "Storage",
"code": "storage",
"aggregation_type": "sum_agg"
},
"grouped_usage": [
{
"amount_cents": 1000,
"projected_amount_cents": 2000,
"events_count": 10,
"units": "0.9",
"projected_units": "1.8",
"grouped_by": {},
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"filters": [
{
"units": "0.9",
"projected_units": "1.8",
"amount_cents": 1000,
"projected_amount_cents": 2000,
"events_count": 10,
"values": {
"region": [
"us-east-1"
]
},
"invoice_display_name": "AWS eu-east-1",
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
],
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
],
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"filters": [
{
"units": "0.9",
"projected_units": "1.8",
"amount_cents": 1000,
"projected_amount_cents": 2000,
"events_count": 10,
"values": {
"region": [
"us-east-1"
]
},
"invoice_display_name": "AWS eu-east-1",
"pricing_unit_details": {
"amount_cents": 200,
"short_name": "CR",
"conversion_rate": "0.5"
},
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
],
"presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
],
"projected_presentation_breakdowns": [
{
"presentation_by": {},
"units": "9.0"
}
]
}
]
}
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 403,
"error": "Forbidden",
"code": "feature_unavailable"
}{
"status": 404,
"error": "Not Found",
"code": "object_not_found"
}{
"status": 405,
"error": "Method Not Allowed",
"code": "not_allowed"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The customer external unique identifier (provided by your own application).
Example:
"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
Query Parameters
The unique identifier of the subscription within your application.
Example:
"sub_1234567890"
Optional flag to determine if taxes should be applied. Defaults to true if not provided or if null.
Example:
true
Filter usage to a specific charge by its Lago ID (UUID).
Example:
"1a901a90-1a90-1a90-1a90-1a901a901a90"
Filter usage to a specific charge by its code.
Example:
"storage"
Filter usage to a specific billable metric by its code.
Example:
"storage"
Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. group[cloud]=aws.
Show child attributes
Show child attributes
Example:
{ "cloud": "aws" }
Filter presentation_breakdowns by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable presentation_breakdowns entirely.
Example:
"[\"engineering\", \"operations\"]"
Response
Customer usage
Show child attributes
Show child attributes