Skip to main content
GET
/
analytics
/
overdue_balance
List overdue balance
curl --request GET \
  --url https://api.getlago.com/api/v1/analytics/overdue_balance \
  --header 'Authorization: Bearer <token>'
{
  "overdue_balances": [
    {
      "month": "2023-11-01T00:00:00.000Z",
      "amount_cents": 50000,
      "currency": "USD",
      "lago_invoice_ids": [
        "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
currency
enum<string>

Currency of revenue analytics. Format must be ISO 4217.

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,
SZL,
THB,
TJS,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
Example:

"USD"

​
external_customer_id
string

The customer external unique identifier (provided by your own application). Use it to filter revenue analytics at the customer level.

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
months
integer

Show data only for given number of months.

Example:

12

Response

Overdue balance

​
overdue_balances
object[]
required