GET
/
v1
/
customer-meters
/
{id}
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.CustomerMeters.Get(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerMeter != nil {
        // handle response
    }
}
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
  "consumed_units": 25,
  "credited_units": 100,
  "balance": 75,
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "tax_id": [
      "911144442",
      "us_ein"
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
  },
  "meter": {
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "filter": {
      "conjunction": "and",
      "clauses": [
        {
          "property": "<string>",
          "operator": "eq",
          "value": "<string>"
        }
      ]
    },
    "aggregation": {
      "func": "count"
    },
    "organization_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string
required

The customer meter ID.

Response

200
application/json
Successful Response

An active customer meter, with current consumed and credited units.

​
id
string
required

The ID of the object.

​
created_at
string
required

Creation timestamp of the object.

​
modified_at
string | null
required

Last modification timestamp of the object.

​
customer_id
string
required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

​
meter_id
string
required

The ID of the meter.

Example:

"d498a884-e2cd-4d3e-8002-f536468a8b22"

​
consumed_units
number
required

The number of consumed units.

Example:

25

​
credited_units
integer
required

The number of credited units.

Example:

100

​
balance
number
required

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

Example:

75

​
customer
object
required

The customer associated with this meter.

​
meter
object
required

The meter associated with this customer.

Was this page helpful?