---
title: "List meters"
canonical_url: "https://twominutebilling.com/help/developers/api-reference/usage/list-meters"
---
# List meters

<api-operation method="GET" path="/v1/businesses/{biz}/meters">
<template v-slot:docs="">

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      The business's id (biz_…).
    </td>
  </tr>
</tbody>
</table>

## Query parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        include_archived
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      no
    </td>
    
    <td>
      Include archived meters.
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        list
      </code>
      
      . One of <code>
        list
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The rows on this page.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        meter
      </code>
      
      . One of <code>
        meter
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The meter's id.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.name
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The meter's name.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.event_name
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The event name it reads.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.aggregation
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      How events combine in a period. <code>
        avg
      </code>
      
       = total of the values ÷ number of events. <code>
        unique
      </code>
      
       counts distinct values of <code>
        unique_property
      </code>
      
      . <code>
        weighted_sum
      </code>
      
       bills a level × the time it held. One of <code>
        sum
      </code>
      
      , <code>
        count
      </code>
      
      , <code>
        min
      </code>
      
      , <code>
        max
      </code>
      
      , <code>
        avg
      </code>
      
      , <code>
        last
      </code>
      
      , <code>
        unique
      </code>
      
      , <code>
        weighted_sum
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.value_property
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The property holding the number. Required except for <code>
        count
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.unique_property
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        unique
      </code>
      
       only: the property whose distinct values are counted.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.recurring
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      sum, last, max and unique only: the level carries into the next period.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.time_unit
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        weighted_sum
      </code>
      
       only. One of <code>
        hour
      </code>
      
      , <code>
        day
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.filters
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      An event counts only when every listed property has one of its values.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.group_by
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      Up to 5 property names, in order. A price can set a rate for each combination.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.limit_dimensions
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      Up to 3 event properties a spend limit can name (<code>
        property_key
      </code>
      
      ), so each value of the property has its own limit. Can change after the meter has usage.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.price_list
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      Maps each combination to a model price list key, for <code>
        model_price_list
      </code>
      
       prices and line cost. Each key it reads must be in <code>
        group_by
      </code>
      
      . Can change after the meter has usage.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.cost_currency
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The currency of event <code>
        cost
      </code>
      
       for events that name none. Null = the price's currency.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.status
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The meter's status. One of <code>
        active
      </code>
      
      , <code>
        archived
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.locked
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      True once the meter has a counted event or a price: only <code>
        name
      </code>
      
       can change.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.created_at
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When the meter was created (ISO-8601 UTC).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.updated_at
      </code>
    </td>
    
    <td>
      <code>
        string · ISO-8601
      </code>
    </td>
    
    <td>
      When the meter was last changed (ISO-8601 UTC).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.resource_version
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      A number that goes up on every change.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        has_more
      </code>
    </td>
    
    <td>
      <code>
        boolean
      </code>
    </td>
    
    <td>
      Whether more rows exist after this page.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        next_cursor
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Pass as <code>
        starting_after
      </code>
      
       to get the next page. Null on the last page.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      The business's meters.
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/meters" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">

```json [200 OK]
{
  "object": "list",
  "data": [
    {
      "object": "meter",
      "id": "ai_tokens",
      "name": "AI tokens",
      "event_name": "ai_tokens",
      "aggregation": "sum",
      "status": "active"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.