GetEntitlementPlans
const url = 'https://example.com/api/v1/provision/consumer/me/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plans?pageNumber=1&pageSize=100';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/v1/provision/consumer/me/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plans?pageNumber=1&pageSize=100'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Responses
Section titled “Responses”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
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
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.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
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
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
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.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Examplegenerated
{ "pageNumber": 1, "pageSize": 1, "totalCount": 1, "items": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "sortOrder": 1, "featureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ] } ], "totalPages": 1, "hasPreviousPage": true, "hasNextPage": true}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
The 1-based index of this page within the full result set.
The maximum number of items per page that was requested.
The total number of items across all pages.
The items on this page.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
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.
Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).
Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).
Examplegenerated
{ "pageNumber": 1, "pageSize": 1, "totalCount": 1, "items": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "sortOrder": 1, "featureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ] } ], "totalPages": 1, "hasPreviousPage": true, "hasNextPage": true}Unauthorized
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Service Unavailable