Lists suites with pagination, sorting, and filtering.
const url = 'https://example.com/api/v1/provision/admin/suites?pageNumber=1&pageSize=100&includeImplicit=false';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/admin/suites?pageNumber=1&pageSize=100&includeImplicit=false'Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”1-based page number to return.
Maximum number of items per page.
Optional sort expression; ascending when omitted.
Optional filter expression applied to the results.
When true, also returns the implicit suites-of-one created automatically behind each priced product. They are excluded by default.
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 suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.
object
One member product of a suite, in sell order.
object
True for the suite auto-created behind a product the first time it is priced, rather than
one an operator built. Listing excludes these by default; pass includeImplicit to
see them. Becomes false permanently once a second product joins.
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 suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.
object
One member product of a suite, in sell order.
object
True for the suite auto-created behind a product the first time it is priced, rather than
one an operator built. Listing excludes these by default; pass includeImplicit to
see them. Becomes false permanently once a second product joins.
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", "code": "example", "name": "example", "description": "example", "members": [ { "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "productCode": "example", "productName": "example", "sortOrder": 1 } ], "isImplicit": true } ], "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 suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.
object
One member product of a suite, in sell order.
object
True for the suite auto-created behind a product the first time it is priced, rather than
one an operator built. Listing excludes these by default; pass includeImplicit to
see them. Becomes false permanently once a second product joins.
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", "code": "example", "name": "example", "description": "example", "members": [ { "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "productCode": "example", "productName": "example", "sortOrder": 1 } ], "isImplicit": true } ], "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"}