Customer usage
Retrieve past usage
Fetch historical customer usage data for closed billing periods.
GET
/
customers
/
{external_customer_id}
/
past_usage
Authorization
Path
Query
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
EXTERNAL_CUSTOMER_ID="__EXTERNAL_CUSTOMER_ID__"
EXTERNAL_SUBSCRIPTION_ID="__EXTERNAL_SUBSCRIPTION_ID__"
curl --location --request GET "$LAGO_URL/api/v1/customers/$EXTERNAL_CUSTOMER_ID/past_usage?external_subscription_id=$EXTERNAL_SUBSCRIPTION_ID" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json'
{
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_count": 70,
"total_pages": 4
},
"usage_periods": [
{
"customer_usage": {
"amount_cents": 123,
"charges_usage": [],
"from_datetime": "2022-07-01T00:00:00Z",
"issuing_date": "2022-08-01T23:59:59Z",
"taxes_amount_cents": 200,
"to_datetime": "2022-07-31T23:59:59Z",
"total_amount_cents": 123
}
}
]
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
external_customer_id
string
requiredThe customer external unique identifier (provided by your own application).
Query Parameters
page
integer
Page number.
per_page
integer
Number of records per page.
external_subscription_id
string
requiredThe unique identifier of the subscription within your application.
billable_metric_code
string
Billable metric code filter to apply to the charge usage
periods_count
integer
Number of past billing period to returns in the result
Response
200 - application/json
meta
object
requiredusage_periods
object[]
requiredWas this page helpful?
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
EXTERNAL_CUSTOMER_ID="__EXTERNAL_CUSTOMER_ID__"
EXTERNAL_SUBSCRIPTION_ID="__EXTERNAL_SUBSCRIPTION_ID__"
curl --location --request GET "$LAGO_URL/api/v1/customers/$EXTERNAL_CUSTOMER_ID/past_usage?external_subscription_id=$EXTERNAL_SUBSCRIPTION_ID" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json'
{
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_count": 70,
"total_pages": 4
},
"usage_periods": [
{
"customer_usage": {
"amount_cents": 123,
"charges_usage": [],
"from_datetime": "2022-07-01T00:00:00Z",
"issuing_date": "2022-08-01T23:59:59Z",
"taxes_amount_cents": 200,
"to_datetime": "2022-07-31T23:59:59Z",
"total_amount_cents": 123
}
}
]
}