The attributed usage object

{
  "lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "external_subscription_id": "sub_1234567890",
  "group_by": "team",
  "basis": "amount",
  "from_datetime": "2022-04-01T00:00:00Z",
  "to_datetime": "2022-04-30T23:59:59Z",
  "currency": "USD",
  "split_filters_count": 42,
  "rows": [
    {
      "value": "engineering",
      "rank": 1,
      "amount_cents": 1200,
      "precise_amount_cents": "1200.4567",
      "events_count": 42,
      "split_charge_units": "15000.5",
      "charges_usage": [
        {
          "lago_charge_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "charge_code": "tokens",
          "billable_metric_code": "tokens",
          "lago_charge_filter_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "charge_filter_values": {
            "model": [
              "opus"
            ]
          },
          "charge_filter_invoice_display_name": "Opus tokens",
          "units": "1250.5",
          "amount_cents": 1200,
          "precise_amount_cents": "1200.4567",
          "events_count": 42
        }
      ]
    }
  ],
  "unattributed": {
    "amount_cents": 1200,
    "precise_amount_cents": "1200.4567",
    "events_count": 42,
    "split_charge_units": "15000.5",
    "charges_usage": [
      {
        "lago_charge_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "charge_code": "tokens",
        "billable_metric_code": "tokens",
        "lago_charge_filter_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "charge_filter_values": {
          "model": [
            "opus"
          ]
        },
        "charge_filter_invoice_display_name": "Opus tokens",
        "units": "1250.5",
        "amount_cents": 1200,
        "precise_amount_cents": "1200.4567",
        "events_count": 42
      }
    ]
  },
  "totals": {
    "amount_cents": 1200,
    "precise_amount_cents": "1200.4567",
    "events_count": 42,
    "split_charge_units": "15000.5",
    "charges_usage": [
      {
        "lago_charge_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "charge_code": "tokens",
        "billable_metric_code": "tokens",
        "lago_charge_filter_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "charge_filter_values": {
          "model": [
            "opus"
          ]
        },
        "charge_filter_invoice_display_name": "Opus tokens",
        "units": "1250.5",
        "amount_cents": 1200,
        "precise_amount_cents": "1200.4567",
        "events_count": 42
      }
    ]
  }
}

lago_subscription_id

string<uuid>

required

Unique identifier of the subscription, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

external_subscription_id

string

required

Unique identifier of the subscription in your application.

Example:

"sub_1234567890"

group_by

string

required

Code of the usage attribution type the usage is grouped by.

Example:

"team"

basis

enum<string>

required

Basis of the breakdown. With units, amounts are null and values are ranked by units, summed across the selected charges. With amount, amounts are computed and values are ranked by amount.

Available options:

units,

amount

Example:

"amount"

from_datetime

string<date-time>

required

Start of the period of the usage, in UTC.

Example:

"2022-04-01T00:00:00Z"

to_datetime

string<date-time>

required

End of the period of the usage, in UTC.

Example:

"2022-04-30T23:59:59Z"

currency

enum<string>

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SYP,

SZL,

THB,

TJS,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

split_filters_count

integer | null

required

Number of filters of the charge split by split_charge_code, across all pages. Each response returns up to 10 of them, starting at split_filters_offset. It is null when no charge is split.

Example:

42

rows

object[]

required

Usage of each attribution value of the page, ordered by rank.

Show child attributes

unattributed

object

required

Usage of the events that carry no value for the group_by usage attribution type.

Show child attributes

totals

object

required

Usage of the whole level, attributed and unattributed, for all pages. A search_term does not narrow the totals.

Show child attributes