---
title: "Get plan usage for one meter"
method: GET
path: "/organization/meters/{eventName}"
tags: ["Organizations"]
---

# Get plan usage for one meter

`GET /organization/meters/{eventName}`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/organization/meters/{eventName}`
- Auth: API key in header `x-api-key`

Usage against the plan's included quota for one meter — `tracked_videos`, `tracked_accounts`, `active_creators`, `creator_invites_daily`, `active_jobs`, `team_seats`, or `extra_credits`. Available to every member, unlike `/organization/subscription`.

## Path parameters

- `eventName` 'team_seats' | 'tracked_accounts' | 'tracked_videos' | 'active_creators' | 'creator_invites_daily' | 'active_jobs' | 'extra_credits', required

## Response `200`

OK

- object: Meter usage response mirroring Polar metering state and computed quotas.
  - `meter` object, required
    - `id` string, required
    - `name` string, required
    - `eventName` 'team_seats' | 'tracked_accounts' | 'tracked_videos' | 'active_creators' | 'creator_invites_daily' | 'active_jobs' | 'extra_credits', required
    - `aggregation` 'avg' | 'count' | 'max' | 'min' | 'sum' | 'unique', required
    - `metadata` object
    - `organizationId` string
    - `createdAt` string, date-time
    - `modifiedAt` string, date-time, nullable
    - `archivedAt` string, date-time, nullable
  - `benefit` object, nullable
    - `id` string, required
    - `type` 'meter_credit', required
    - `description` string
    - `properties` object, required
      - `units` number, required
      - `rollover` boolean, required
      - `meterId` string, required
    - `selectable` boolean
    - `deletable` boolean
    - `organizationId` string
    - `metadata` object
    - `createdAt` string, date-time
    - `modifiedAt` string, date-time, nullable
  - `price` object, nullable
    - `id` string, required
    - `amountType` 'metered_unit', required
    - `unitAmount` number, required
    - `priceCurrency` string, required
    - `recurringInterval` union
      - 'day' | 'week' | 'month' | 'year'
      - unknown
    - `capAmount` number, nullable
    - `meterId` string
    - `productId` string
  - `quantities` object, required
    - `total` number, required
    - `current` number, required
    - `benefited` number, required
    - `extra` number, required
    - `unused` number, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)