# UsageSummaryDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Usage summary for a given scope (merchant, reseller) and period,
with per-SKU breakdown.

## Fields
- `resellerId` (string(uuid)): Reseller ID for this summary.
- `merchantId` (string(uuid)): Merchant ID for this summary. Null for reseller-level summaries. (nullable)
- `periodKey` (string): Period key (e.g., "202602" for monthly). (nullable)
- `skus` (array<[SkuUsageSummaryDto](https://devportal.demo.winkpg.io/docs/api/models/SkuUsageSummaryDto.md)>): Per-SKU usage summaries. (nullable)
  Fields of each item:
  - `skuCode` (string): The SKU code. (nullable)
  - `displayName` (string): Display name from the SKU definition. (nullable)
  - `unitName` (string): Unit of measurement label. (nullable)
  - `category` (string): Logical grouping category. (nullable)
  - `totalQuantity` (integer(int64)): Total quantity consumed in this period.
  - `totalAmount` (number(double)): Sum of dollar values in this period (for percentage billing). (nullable)
  - `amountCurrency` (string): ISO currency code for the amount. (nullable)
  - `entryCount` (integer(int64)): Number of ledger entries in this period.
  - `includedQuantity` (integer(int64)): Included quantity from the effective entitlement.
  - `isUnlimited` (boolean): True when the effective entitlement has no enforceable upper bound. The UI  should render "Unlimited" instead of `includedQuantity` and hide  progress meters. Set by the server when `HardLimitEnabled == false` or  when `IncludedQuantity == long.MaxValue` (the platform-default sentinel).
  - `hardLimitEnabled` (boolean): Whether a hard limit is enforced.
  - `overageAllowed` (boolean): Whether overage is allowed.
  - `remaining` (integer(int64)): Remaining quantity, or null if unlimited. (nullable)
  - `inOverage` (boolean): Whether the current usage exceeds the included quantity.
  - `percentageUsed` (number(double)): Percentage of included quantity consumed (0.0 to 1.0+).  Greater than 1.0 indicates overage.

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.