---
title: "Account identity, plan and lifetime analysis totals"
method: GET
path: "/v1/usage"
tags: ["History"]
---

# Account identity, plan and lifetime analysis totals

`GET /v1/usage`

## Request

- Base URL: `https://carbonguru.io`
- URL: `https://carbonguru.io/v1/usage`
- Auth: HTTP bearer

account and plan come from the platform's whoami read; lifetime comes from its analysis-stats read. period is null: analyses this period, the allowance and the reset date need the one allowance principal of ADR-010 stage 0l, which is not built, and no number is invented in the meantime.

## Response `200`

The account's usage summary.

- Usage
  - `account` object
    - `user_id` string
    - `email` string, nullable
    - `display_name` string, nullable
    - `account_type` string
    - `member_since` string, nullable
  - `scopes` string[], nullable
  - `plan` object, nullable: The account's CarbonGuru subscription, as the platform reports it.
  - `lifetime` object
    - `total_items` integer, nullable
    - `total_carbon_kg` number, nullable
    - `avg_carbon_kg` number, nullable
    - `total_sessions` integer, nullable
  - `period` unknown

## Other responses

- `401`: No valid credential. Every authentication failure returns this one document.
- `403`: A missing scope, an exhausted analysis allowance, or an object that is not the caller's.

---

[API](https://skmtc.dev/carbonguru/apis/carbonguru-api.md) · [All operations](https://skmtc.dev/carbonguru/apis/carbonguru-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonguru/apis/carbonguru-api/revisions/26dcbe7a8500?raw)