SkuEntitlementDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read DTO for a 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) | Unique identifier of the 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.
| ||||||||||
skuCode
required |
string | The SKU code this entitlement applies 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.
| ||||||||||
scope
required |
EntitlementScope EntitlementScope | The scope level of this 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.
| ||||||||||
resellerId
required |
string (uuid) | Reseller ID. Set for Reseller and Merchant scope.
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.
| ||||||||||
merchantId
required |
string (uuid) | Merchant ID. Set for Merchant scope only.
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 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.
| ||||||||||
hardLimitEnabled
required |
boolean | Whether this SKU enforces a hard limit.
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.
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. Null means unlimited overage.
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.
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.
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.
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.