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
DimensionalUsageDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One row of a dimensional usage rollup: e.g. "Processor=TSYS: 12,345 auths, $250,000".
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 skuCode
required string
The SKU code this rollup belongs to.
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").
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.
dimensionKey
required string
Dimension key: e.g. "Processor".
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.
dimensionValue
required string
Dimension value: e.g. "TSYS".
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)
Sum of quantities for this dimension+value within the 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 for this dimension+value (when applicable).
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 `totalAmount`.
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)
Count of ledger entries that contributed to this rollup.
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 model has no documented fields.
Next steps