EffectiveEntitlementDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
DTO representing the resolved effective entitlement for a SKU after walking the Merchant → Reseller → Platform → Default chain.
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.
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.
| ||||||||||
resolvedFromScope
required |
EntitlementScope EntitlementScope | Which scope provided the entitlement 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.
| ||||||||||
sourceEntitlementId
required |
string (uuid) | The source entitlement ID, if resolved from a persisted entitlement.
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.
| ||||||||||
includedQuantity
required |
integer (int64) | Included quantity per 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.
| ||||||||||
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.
| ||||||||||
overageLimitQuantity
required |
integer (int64) | Cap on overage. Null = 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.
| ||||||||||
enabled
required |
boolean | Whether the SKU is enabled at this scope.
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.
| ||||||||||
resetPeriod
required |
ResetPeriod ResetPeriod | The reset 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.
| ||||||||||
maxAllowedQuantity
required |
integer (int64) | Maximum allowed quantity (included + overage cap), 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.
|
This model has no documented fields.