SIMs (Devices)

Get current billing period usage for a SIM card

Returns one aggregate usage record for a SIM's current unique 30-day billing period. Optionally restrict the total to one cellular link; linkids identifies all links included in the aggregate. Set with_session_details=true to also receive, per link, the most recent closed session rolled into the total (most_recent_sessions) and any in-flight session not yet billed (open_sessions).

get/usage/billing/simcard/{simcardid}

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/usage/billing/simcard/:simcardid/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

simcardidinteger required

SIM card ID to get current billing period usage for

Query parameters

linkidinteger

Filter by a specific cellular link (SIM profile) ID

with_session_detailsboolean

When true, adds most_recent_sessions and open_sessions (one entry per link, each carrying its linkid) to the record. Defaults to false.

Response

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.