POpolar
customer_meters
public

Get Customer Meter

Changed on

Get a customer meter by ID.

Scopes: customer_meters:read

get/v1/customer-meters/{id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customer-meters/{id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: customer_meters:read)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring uuid4 required

The customer meter ID.

Response

Successful Response

idstring uuid4 required

The ID of the object.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

customer_idstring uuid4 required

The ID of the customer.

meter_idstring uuid4 required

The ID of the meter.

consumed_unitsnumber required

The number of consumed units.

credited_unitsinteger required

The number of credited units.

balancenumber required

The balance of the meter, i.e. the difference between credited and consumed units.

customerCustomer required(unresolved $ref)

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status