---
title: "Print current API usage."
method: GET
path: "/api2/json/apiUsage"
tags: ["admin"]
---

# Print current API usage.

`GET /api2/json/apiUsage`

## Response `200`

Print current API usage.

- APIPeriodUsageOut
  - `subscription` APIPlanSubscriptionOut — The API Plan governing the subscription.
    - `apiKey` string — User API Key.
    - `planStarted` integer — Datetime when the user subscribed to the current plan.
    - `taxRate` number, double — Applicable tax rate for the plan.
    - `planName` string — Current plan name.
    - `planBaseFeesKey` string — Current plan key (as in Stripe product).
    - `planQuota` integer — Plan status.
    - `price` number, double — Current plan price for overages expressed in Currency (extra price per unit above the free quota).
    - `planDiscountInPercent` number, double — Plan discount rate in pct.
    - `priceOverage` number, double — Current plan price for overages expressed in Currency (extra price per unit above the free quota).
    - `overageDiscountInPercent` number, double — Overage discount rate in pct.
    - `currency` string — Current plan Currency for prices.
    - `currencyFactor` number, double — For USD, GBP, EUR - the factor is 1.
    - `stripeCustomerId` string — Stripe customer identifier.
    - `stripeStatus` string — Stripe status ex active.
    - `stripeSubscription` string — Stripe subscription identifier.
    - `userId` string — Internal user identifier.
  - `billingPeriod` APIBillingPeriodUsageOut — The current billing period.
    - `subscriptionStarted` integer — Datetime when the user subscribed to the plan.
    - `periodStarted` integer — Datetime when the the plan's current period started.
    - `periodEnded` integer — Datetime when the the plan's current period endend.
    - `usage` integer — Current period usage in units (NB some API endpoints use more than one unit).
    - `softLimit` integer — Current period soft limit (reaching the limit sends an email notification).
    - `hardLimit` integer — Current period hard limit (reaching the limit sends an email notification and blocks the API Key).
  - `overageExclTax` number, double — Overage amount including any tax.
  - `overageInclTax` number, double — Overage amount including tax (if applicable).
  - `overageCurrency` string — Currency of the overage amount.
  - `overageQuantity` integer — Quantity above monthly quota of the current subscritpion, in units.

## Other responses

- `401` — Missing or incorrect API Key
- `429` — Too Many Requests

---

[API](https://skmtc.net/namsor/apis/namsor-api-v2.md) · [All operations](https://skmtc.net/namsor/apis/namsor-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/namsor/namsor-api-v2/revisions/305e4f6eeaf5/schema)