Create Meter

Create a meter.

Scopes: meters:write

post/v1/meters/

Request

Base URL
https://api.polar.sh
URL
https://api.polar.sh/v1/meters/
Auth
- OpenID Connect (/.well-known/openid-configuration, scopes: meters:write)
- or HTTP bearer
- or HTTP bearer

Request body

metadataobject

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.

namestring required

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

unit'scalar' | 'token' | 'custom'

custom_labelstring nullable

The label for the custom unit, e.g. 'request'. Required when unit is 'custom'.

custom_multiplierinteger nullable

The multiplier to convert from the base unit to display scale, e.g. 1000 to display per 1000 units. Defaults to 1 when not provided.

organization_idstring uuid4 nullable

The organization ID.

Example request

{
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}

Response

Meter created.

metadataMetadataOutputType required

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

namestring required

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

unit'scalar' | 'token' | 'custom' required

custom_labelstring nullable

The label for the custom unit.

custom_multiplierinteger nullable

The multiplier to convert from base unit to display scale.

organization_idstring uuid4 required

The ID of the organization owning the meter.

archived_atstring date-time nullable

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

Changes

No recorded changes to this operation across all 11 revisions of this API.