UpdateSkuEntitlementDto
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 updating an existing SKU 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.
Fields
| Field | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
includedQuantity
required |
integer (int64) | Included quantity per reset period; 0 means unlimited. Omit it, or send null, to keep the
entitlement's current quantity.
nullablemin 0
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 this SKU enforces a hard limit. Omit it, or send null, to keep the entitlement's
current setting.
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.
| ||||||||||
overageAllowed
required |
boolean | Whether overage beyond the included quantity is allowed. Omit it, or send null, to keep
the entitlement's current setting.
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.
| ||||||||||
overageLimitQuantity
required |
integer (int64) | Cap on overage quantity. Send null to remove the cap and allow unlimited overage. Omit the
property entirely to keep the entitlement's current cap.
Conditional: When OverageLimitQuantity is not null. Must be >= 0.
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 | Kill switch: when false, all consumption of this SKU is blocked. Omit it, or send null, to
keep the entitlement's current setting.
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.
| ||||||||||
resetPeriod
required |
ResetPeriod ResetPeriod | How often the usage counter resets. Omit it, or send null, to keep the entitlement's
current reset period.
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.
| ||||||||||
concurrencyStamp
required |
string | Optimistic concurrency stamp for update verification.
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.