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:57 UTC.
API reference
/
Models
ContinuationPagedResultDtoOfSkuEntitlementDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents a page of results obtained through continuation-token paging.
Supports an approximate total count for display purposes.
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 items
required array of SkuEntitlementDto
array of SkuEntitlementDto The items returned for this page.
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.
Fields of each SkuEntitlementDto:
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.
PlatformPlatform-wide default applicable to all resellers and merchants. ResellerReseller-level override applicable to the reseller and its merchants. MerchantMerchant-level override applicable to a specific merchant only. PlanPlan-level default applicable to every merchant carrying the matching plan code.
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.
MonthlyResets at the start of each calendar month (UTC). QuarterlyResets at the start of each calendar quarter (UTC). AnnualResets at the start of each calendar year (UTC). NoneNever resets. Lifetime quota. DailyResets at the start of each calendar day (UTC).
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 body has no documented fields.
nextContinuationToken
required string
Continuation token to use when requesting the next page.
Null means no additional pages exist.
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.
approxTotalCount
required integer (int64)
An approximate total count of matching items.
This value is optional and may be stale or estimated, so treat it as an approximation.
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.
pageItemCount
required integer (int32)
Convenience property for the number of items in this page.
read only 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.
retrievedAt
required string (date-time)
When the page was retrieved. Useful for diagnostics and cache behavior.
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