PATCH
/
v1
/
meters
/
{id}
Typescript (SDK)
import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.meters.update({
    id: "<value>",
    meterUpdate: {},
  });

  console.log(result);
}

run();
{
  "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>",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid4>
required

The meter ID.

Body

application/json
​
metadata
object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

  • A string with a maximum length of 500 characters
  • An integer
  • A floating-point number
  • A boolean

You can store up to 50 key-value pairs.

​
name
string | null

The name of the meter. Will be shown on customer's invoices and usage.

Minimum length: 3
​
filter
object | null

The filter to apply on events that'll be used to calculate the meter.

​
aggregation
object | null

The aggregation to apply on the filtered events to calculate the meter.

​
is_archived
boolean | null

Whether the meter is archived. Archived meters are no longer used for billing.

Response

Meter updated.

​
metadata
object
required
​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
id
string<uuid4>
required

The ID of the object.

​
name
string
required

The name of the meter. Will be shown on customer's invoices and usage.

​
filter
object
required

The filter to apply on events that'll be used to calculate the meter.

​
aggregation
object
required

The aggregation to apply on the filtered events to calculate the meter.

​
organization_id
string<uuid4>
required

The ID of the organization owning the meter.

​
archived_at
string<date-time> | null

Whether the meter is archived and the time it was archived.