WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

API reference Models

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.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
resellerId required string (uuid) Reseller ID for this summary.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
merchantId required string (uuid) Merchant ID for this summary. Null for reseller-level summaries. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
periodKey required string Period key (e.g., "202602" for monthly). nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
skus required array of SkuUsageSummaryDto array of SkuUsageSummaryDto Per-SKU usage summaries. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each SkuUsageSummaryDto:

Field Type Description
skuCode required string The SKU code. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
displayName required string Display name from the SKU definition. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
unitName required string Unit of measurement label. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
category required string Logical grouping category. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
totalQuantity required integer (int64) Total quantity consumed in this period.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
totalAmount required number (double) Sum of dollar values in this period (for percentage billing). nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
amountCurrency required string ISO currency code for the amount. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
entryCount required integer (int64) Number of ledger entries in this period.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
includedQuantity required integer (int64) Included quantity from the effective entitlement.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isUnlimited required 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).
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
hardLimitEnabled required boolean Whether a hard limit is enforced.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
overageAllowed required boolean Whether overage is allowed.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
remaining required integer (int64) Remaining quantity, or null if unlimited. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
inOverage required boolean Whether the current usage exceeds the included quantity.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
percentageUsed required number (double) Percentage of included quantity consumed (0.0 to 1.0+). Greater than 1.0 indicates overage.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.