Retrieve past usage

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

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

external_customer_id

string

required

The 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

required

The 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

required

usage_periods

object[]

required

usage_periods.customer_usage

object

required

usage_periods.customer_usage.amount_cents

integer

required

The amount in cents, tax excluded.

usage_periods.customer_usage.charges_usage

object[]

required

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

usage_periods.customer_usage.charges_usage.amount_cents

integer

required

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

usage_periods.customer_usage.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

usage_periods.customer_usage.charges_usage.billable_metric

object

required

The related billable metric object.

usage_periods.customer_usage.charges_usage.charge

object

required

Object listing all the properties for a specific charge item.

usage_periods.customer_usage.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.

usage_periods.customer_usage.charges_usage.groups

object[]

required

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

usage_periods.customer_usage.charges_usage.units

string

required

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

usage_periods.customer_usage.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

usage_periods.customer_usage.from_datetime

string

required

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

usage_periods.customer_usage.issuing_date

string

required

The date of creation of the invoice.

usage_periods.customer_usage.lago_invoice_id

string | null

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

usage_periods.customer_usage.taxes_amount_cents

integer

required

The tax amount in cents.

usage_periods.customer_usage.to_datetime

string

required

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

usage_periods.customer_usage.total_amount_cents

integer

required

The total amount in cents, tax included.

Was this page helpful?

Retrieve current usage The customer object

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
      }
    }
  ]
}

API Reference

Authorizations

Path Parameters

Query Parameters

Response