Skip to content

Lists the monitored assets (metered quotas and prepaid balances) attached to an entitlement the current user can access — the me-scoped counterpart of the admin by-entitlement listing, so the end-user license portal can surface its own balances without an admin credential.

GET
/api/v1/provision/consumer/me/entitlements/{entitlementId}/monitored-assets
curl --request GET \
--url 'https://example.com/api/v1/provision/consumer/me/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/monitored-assets?pageNumber=1&pageSize=100'
entitlementId
required
string format: uuid

Entitlement id.

pageNumber
integer | string format: int32
default: 1 /^-?(?:0|[1-9]\d*)$/

1-based page number to return.

pageSize
integer | string format: int32
default: 100 /^-?(?:0|[1-9]\d*)$/

Maximum number of items per page.

OK

Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.

object
pageNumber

The 1-based index of this page within the full result set.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
pageSize

The maximum number of items per page that was requested.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalCount

The total number of items across all pages.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
items

The items on this page.

Array<object>

A metered or credit-backed asset on an entitlement the calling user holds: what it measures, where consumption currently stands, and what remains.

object
id
string format: uuid
metricName

The name consumption is reported under.

string
name

Display name, when the asset carries one distinct from its metric name.

string
unit

What the value counts — seconds, renders, miles.

string
numberFormat

Format hint for rendering decimal MyMonitoredAssetDto.CurrentValue, e.g. "0.00".

string
currentValue

Consumption recorded so far, on the asset’s own counter.

number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
currentPeriodUsage

Consumption in the period the quota is measured over, or null when the asset carries no metered quota — a credit-backed asset measures a balance rather than a period.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
periodLimit

Where the current period’s quota runs out, or null when there is no metered quota. The figure to compare double? MyMonitoredAssetDto.CurrentPeriodUsage against.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
consumptionPeriod

The period the quota resets on, e.g. "Monthly". Empty when the asset has no metered quota.

string
overageStatus

Severity of consumption relative to the quota, as a stable name: None, Normal, Warning, Critical or OverUsage. A string rather than the admin enum so a consumer app does not take a dependency on the admin DTO package to read its own status.

string
suspendedUntilAt

When consumption is suspended until, or null when it is not. An app that shows the user why a feature stopped working needs this; it is the one operator decision that reaches them.

null | string format: date-time
balance
One of:
null
totalPages

The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasPreviousPage

Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).

boolean
hasNextPage

Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).

boolean

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string