---
title: "Get org usage"
method: GET
path: "/api/organizations/{name}/billing/usage"
tags: ["orgs"]
---

# Get org usage

`GET /api/organizations/{name}/billing/usage`

Get org usage for a given period

## Path parameters

- `name` string, required

## Query parameters

- `periodId` string

## Response `200`

Usage and period information

- object
  - `usage` object, required
  - `period` object, required
    - `_id` string, required
    - `entityId` string, required
    - `entityType` 'user' | 'org', required
    - `entityName` string, required
    - `periodStart` string, date-time, required
    - `periodEnd` string, date-time, required
    - `invoice` union
      - object
        - `type` 'stripe', required
        - `id` string, required
        - `amountDueCents` number, required
        - `totalCents` number, required
        - `status` 'draft' | 'open' | 'paid' | 'uncollectible' | 'void' | 'unpaid', required
        - `dueDate` string, date-time, required
        - `collectionMethod` 'charge_automatically' | 'send_invoice'
      - object
        - `type` 'no-invoice', required
        - `id` 'no-invoice', required
    - `charges` object[]
      - `_id` string, required
      - `createdAt` string, date-time, required
      - `dueDate` string, date-time, required
      - `usageAtChargeTimeMicroUSD` number, required
      - `amountCents` number, required
      - `billedThrough` 'stripe-payment-intent', required
      - `paymentIntentId` string, required
      - `paymentIntentStatus` 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded', required

---

[API](https://skmtc.net/huggingface/apis/hub-api-endpoints.md) · [All operations](https://skmtc.net/huggingface/apis/hub-api-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/huggingface/hub-api-endpoints/versions/6ab9f7d9cfb5/schema)