Get live usage of a SIM
Retrieve the live usage of a postpaid sim for the latest month it has usage in.
For postpaid sim only
Live usage is a near-real-time estimate built from the sim's usage reports, for monitoring, e.g. to act before a sim goes over its data allowance. It is not the billed usage; use Search postpaid usages for that. Months are calendar months in UTC.
To follow the live usage of every postpaid sim under your partner account, subscribe a webhook
to POSTPAID_SIM_USAGE_UPDATED instead of calling this endpoint for each sim. Use this endpoint to check or resync
a single sim.
Request
Path parameters
ICCID of the sim to retrieve.
Response
200 Live usage is found
A json is returned in the response body with the following fields:
ICCID of the sim.
Year of the month that the usage is for, in UTC.
Month that the usage is for, in UTC. The value is 1 to 12.
Usage from the start of the month, in MB, rounded to 2 decimal places.
Time of the latest usage report in usageMb. Use it to see how recent the usage is.
404 No live usage is recorded for the sim yet
Check the response body for the error details.
Examples
Request
curl -X GET 'https://portal.peplink.com/api/e/v1/cp/sims/{iccid}/live-usage' \ -H 'Authorization: Bearer {token}'Response
{
"iccid": "89000000000000000000",
"year": 2026,
"month": 9,
"usageMb": 886.94,
"lastEventAt": "2026-09-29T02:26:02.000Z"
}