Customer usage
The customer usage object
This object represents the usage-based charges associated with one of your customers for the current billing period. It allows you to monitor customer usage throughout the period.
{
"customer_usage": {
"from_datetime": "2022-07-01T00:00:00Z",
"to_datetime": "2022-07-31T23:59:59Z",
"issuing_date": "2022-08-01",
"amount_cents": 123,
"amount_currency": "EUR",
"total_amount_cents": 123,
"total_amount_currency": "EUR",
"vat_amount_cents": 0,
"vat_amount_currency": "EUR",
"charges_usage": [
{
"units": "1.0",
"amount_cents": 123,
"amount_currency": "EUR",
"charge": {
"lago_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"charge_model": "graduated"
},
"billable_metric": {
"lago_id": "99a6094e-199b-4101-896a-54e927ce7bd7",
"name": "Storage",
"code": "storage",
"aggregation_type": "sum"
},
"groups": [
{
"lago_id": "a78f2185-1474-4a64-95bf-bcd96623fec5",
"key": null,
"value": "europe",
"units": "0.9",
"amount_cents": 1000
}
]
}
]
}
}
Attributes
customer_usage
object
from_datetimerequired
string
The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).
to_datetimerequired
string
The upper bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).
issuing_daterequired
string
The date of creation of the invoice.
amount_centsrequired
integer
The amount in cents, tax excluded.
amount_currencyrequired
string
The currency of the customer’s current usage amount excluding tax.
total_amount_centsrequired
integer
The total amount in cents, tax included.
total_amount_currencyrequired
string
The currency of the customer’s current usage amount including tax.
vat_amount_centsrequired
integer
The tax amount in cents.
vat_amount_currencyrequired
string
The currency of the customer’s current usage tax.
charges_usagerequired
array
{
"customer_usage": {
"from_datetime": "2022-07-01T00:00:00Z",
"to_datetime": "2022-07-31T23:59:59Z",
"issuing_date": "2022-08-01",
"amount_cents": 123,
"amount_currency": "EUR",
"total_amount_cents": 123,
"total_amount_currency": "EUR",
"vat_amount_cents": 0,
"vat_amount_currency": "EUR",
"charges_usage": [
{
"units": "1.0",
"amount_cents": 123,
"amount_currency": "EUR",
"charge": {
"lago_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"charge_model": "graduated"
},
"billable_metric": {
"lago_id": "99a6094e-199b-4101-896a-54e927ce7bd7",
"name": "Storage",
"code": "storage",
"aggregation_type": "sum"
},
"groups": [
{
"lago_id": "a78f2185-1474-4a64-95bf-bcd96623fec5",
"key": null,
"value": "europe",
"units": "0.9",
"amount_cents": 1000
}
]
}
]
}
}