SkuDefinitionDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
DTO for a SKU definition from the in-memory registry.
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
code
required |
string | Globally unique 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 | Human-readable display name.
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.
| ||||||||
description
required |
string | Description of what this SKU measures.
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.
| ||||||||
aggregationType
required |
SkuAggregationType SkuAggregationType | How usage quantities are aggregated.
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.
| ||||||||
defaultIncludedQuantity
required |
integer (int64) | Default included quantity when no explicit entitlement exists.
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.
| ||||||||
supportsHardLimit
required |
boolean | Whether this SKU supports hard-limit enforcement.
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.
| ||||||||
supportsOverage
required |
boolean | Whether this SKU supports 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.
| ||||||||
category
required |
string | Logical grouping for UI rendering.
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.
| ||||||||
requiresInlineAggregation
required |
boolean | Whether aggregates are updated inline during consumption.
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.
| ||||||||
isDeprecated
required |
boolean | Whether this SKU is deprecated.
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.
| ||||||||
environment
required |
UsageEnvironment UsageEnvironment | Environment scope (Production, Sandbox, etc.).
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.
| ||||||||
parentSkuCode
required |
string | Optional parent SKU code for composite/rollup metering.
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.
| ||||||||
supportedDimensions
required |
array of string array of | Dimension keys supported by this SKU.
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.
|
This model has no documented fields.