The customer usage object

from_datetime

string

required

The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).

Example:

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

to_datetime

string

required

The upper bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).

Example:

"2022-07-31T23:59:59Z"

issuing_date

string

required

The date of creation of the invoice.

Example:

"2022-08-01"

amount_cents

integer

required

The amount in cents, tax excluded.

Example:

123

taxes_amount_cents

integer

required

The tax amount in cents.

Example:

200

total_amount_cents

integer

required

The total amount in cents, tax included.

Example:

123

charges_usage

object[]

required

Array of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage.

charges_usage.units

string

required

The number of units consumed by the customer for a specific charge item.

Example:

"1.0"

charges_usage.events_count

integer

required

The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.

Example:

10

charges_usage.amount_cents

integer

required

The amount in cents, tax excluded, consumed by the customer for a specific charge item.

Example:

123

charges_usage.amount_currency

enum<string>

required

The currency of a usage item consumed by the customer.

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,

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"EUR"

charges_usage.charge

object

required

Object listing all the properties for a specific charge item.

charges_usage.billable_metric

object

required

The related billable metric object.

charges_usage.filters

object[]

Array of filter object, representing multiple dimensions for a charge item.

charges_usage.filters.units

string

The number of units consumed for a specific charge filter related to a charge item.

Example:

"0.9"

charges_usage.filters.amount_cents

integer

The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.

Example:

1000

charges_usage.filters.events_count

integer

The quantity of usage events that have been recorded for a particular charge filter during the specified time period. These events may also be referred to as the number of transactions in some contexts.

Example:

10

charges_usage.filters.invoice_display_name

string

Specifies the name that will be displayed on an invoice.

Example:

"AWS eu-east-1"

charges_usage.filters.values

object

List of filter values applied to the usage.

Example:

{ "region": "us-east-1" }

charges_usage.grouped_usage

object[]

Array of aggregated fees, grouped by the event properties defined in a standard charge model.

charges_usage.grouped_usage.amount_cents

integer

The amount in cents, tax excluded, consumed for a specific group related to a charge item.

Example:

1000

charges_usage.grouped_usage.events_count

integer

The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.

Example:

10

charges_usage.grouped_usage.units

string

The number of units consumed for a specific group related to a charge item.

Example:

"0.9"

charges_usage.grouped_usage.grouped_by

object

Key value list of event properties aggregated by the charge model

charges_usage.grouped_usage.filters

object[]

Array of filter object, representing multiple dimensions for a charge item.

charges_usage.grouped_usage.filters.units

string

The number of units consumed for a specific charge filter related to a charge item.

Example:

"0.9"

charges_usage.grouped_usage.filters.amount_cents

integer

The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.

Example:

1000

charges_usage.grouped_usage.filters.events_count

integer

Example:

10

charges_usage.grouped_usage.filters.invoice_display_name

string

Specifies the name that will be displayed on an invoice.

Example:

"AWS eu-east-1"

charges_usage.grouped_usage.filters.values

object

List of filter values applied to the usage.

Example:

{ "region": "us-east-1" }

lago_invoice_id

string | null

A unique identifier associated with the invoice related to this particular usage record.

Example:

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

currency

enum<string>

The currency of the customer's current usage.

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,

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"EUR"

Was this page helpful?

Suggest edits Raise issue

List all credit notes Retrieve current 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,
  "taxes_amount_cents": 200,
  "total_amount_cents": 123,
  "charges_usage": [
    {
      "units": "1.0",
      "events_count": 10,
      "amount_cents": 123,
      "amount_currency": "EUR",
      "charge": {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "charge_model": "graduated",
        "invoice_display_name": "Setup"
      },
      "billable_metric": {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "Storage",
        "code": "storage",
        "aggregation_type": "sum_agg"
      },
      "filters": [
        {
          "units": "0.9",
          "amount_cents": 1000,
          "events_count": 10,
          "invoice_display_name": "AWS eu-east-1",
          "values": {
            "region": "us-east-1"
          }
        }
      ],
      "grouped_usage": [
        {
          "amount_cents": 1000,
          "events_count": 10,
          "units": "0.9",
          "grouped_by": {},
          "filters": [
            {
              "units": "0.9",
              "amount_cents": 1000,
              "events_count": 10,
              "invoice_display_name": "AWS eu-east-1",
              "values": {
                "region": "us-east-1"
              }
            }
          ]
        }
      ]
    }
  ]
}

API Reference