Skip to content

Lists suites that include the given product as a member, with pagination, sorting, and filtering.

GET
/api/v1/provision/admin/suites/by-product/{productId}
curl --request GET \
--url 'https://example.com/api/v1/provision/admin/suites/by-product/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?pageNumber=1&pageSize=100'
productId
required
string format: uuid

Product 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.

sortOrder
string

Optional sort expression; ascending when omitted.

filter
string

Optional filter expression applied to the results.

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 suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.

object
id
string format: uuid
code
string
name
string
description
string
members
Array<object>

One member product of a suite, in sell order.

object
productId
string format: uuid
productCode
string
productName
string
sortOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isImplicit

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.

boolean
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