Read Customer Meter
Intent
Reads the customer meter without changing it.
When to call it
Call this after your application has received or stored the identifier for the customer meter.
Access boundary
Authorize the request with a token that carries customer_portal:read or customer_portal:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Get a meter by ID for the authenticated customer.
Scopes: customer_portal:read customer_portal:write
Authorizations
Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.
Path Parameters
The customer meter ID.
Response
Successful Response
The stable identifier for this record.
The time Ruba created this record.
The time this record last changed.
The ID of the customer.
"992fae2a-2a17-4b7a-8d9e-e287cf90131b"
The ID of the meter.
"d498a884-e2cd-4d3e-8002-f536468a8b22"
The number of consumed units.
25
The number of credited units.
100
The balance of the meter, i.e. the difference between credited and consumed units.
75