Skip to main content

A type that describes the details of the subscription search response.

Types that use SubscriptionSearchResponse

Not used by any types.

Call that uses SubscriptionSearchResponse

GET
/subscription

Fields

Field
Type
Description
href
string
The path to the call URI that produced the current page of results.
limit
integer
The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the method.

Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 20 if omitted.

Default: 20
next
string
The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page.

This field is not returned if fewer records than specified by the limit field are returned.
subscriptions
array of Subscription
The subscriptions that match the search criteria.
total
integer
The total number of matches for the search criteria.