Skip to main content
The billing sessions API gives you access to every charging session on your network. You can retrieve cost breakdowns, download PDF receipts, access organisation-wide invoices, and get live cost estimates for sessions currently in progress.

List sessions

GET /api/v1/billing/sessions Returns charging sessions across your network, with optional filters by date range, charger, and user.
string
ISO 8601 date/time to filter sessions from.
string
ISO 8601 date/time to filter sessions to.
string
Filter sessions to a specific charger.
string
Filter sessions to a specific user.
string
Filter by session status. Accepted values: completed, active, stopped.
number
default:"50"
Maximum number of sessions to return. Max 200.
number
default:"0"
Pagination offset.
string
Unique billing session identifier.
string
Associated OCPP transaction identifier.
number
Total energy delivered in kilowatt-hours.
number
Total amount charged to the driver.
string
ISO 4217 currency code.
string
Session status: completed, active, or stopped.

Get a session

GET /api/v1/billing/sessions/{session_id} Returns full details for a single billing session.
string
required
The unique identifier of the billing session.

Get session cost breakdown

GET /api/v1/billing/sessions/{session_id}/breakdown Returns a line-by-line breakdown of all charges applied to a session — energy, time, flat fees, taxes, and any discounts.
string
required
The unique identifier of the billing session.
object[]

Get current user’s sessions

GET /api/v1/billing/sessions/me Returns billing sessions for the authenticated user. Intended for driver-facing applications.
string
ISO 8601 start date/time.
string
ISO 8601 end date/time.
number
default:"20"
Maximum number of sessions to return.

Get organisation sessions

GET /api/v1/billing/sessions/organization Returns all billing sessions across your entire organisation. Equivalent to the list sessions endpoint but pre-scoped to your organisation’s chargers and users.
string
ISO 8601 start date/time.
string
ISO 8601 end date/time.
string
Filter to a specific site.
number
default:"50"
Maximum number of sessions to return.

Get live cost estimate

GET /api/v1/billing/active-sessions/{transaction_id}/cost-estimate Returns a real-time cost estimate for a session currently in progress. The estimate updates as energy is delivered.
string
required
The OCPP transaction identifier of the active session.

Send session receipt by email

POST /api/v1/billing/receipts/send-email Sends a PDF receipt for a completed session to the specified email address.
string
required
The billing session to generate a receipt for.
string
required
Email address to deliver the receipt to.

Download receipt by transaction

GET /api/v1/billing/receipts/by-transaction/{transaction_id} Downloads a PDF receipt for a session identified by OCPP transaction ID. Returns the PDF file with Content-Type: application/pdf.
string
required
The OCPP transaction identifier.

List organisation invoices

GET /api/v1/billing/organizations/{org_id}/invoices Returns invoices generated for the specified organisation.
string
required
The organisation identifier.
string
ISO 8601 start date to filter invoices from.
string
ISO 8601 end date to filter invoices to.
string
Filter by invoice status. Accepted values: draft, issued, paid, overdue.

Download invoice PDF

GET /api/v1/billing/invoices/{bill_id}/download Downloads the specified invoice as a PDF. Returns Content-Type: application/pdf.
string
required
The unique identifier of the invoice.

Request billing exemption

POST /api/v1/billing/sessions/{session_id}/exemptions Submits an exemption request for a session — for example, if a session was billed incorrectly due to a charger fault.
string
required
The session to request an exemption for.
string
required
Reason for the exemption request.
number
The amount to exempt. Defaults to the full session cost if omitted.

Get monthly energy usage for a user

GET /api/v1/billing/monthly-energy/users/{user_id} Returns a monthly summary of energy consumed and session costs for a specific driver.
string
required
The user identifier.
number
Filter to a specific calendar year (e.g. 2024).