search-subscriptions-request.md

Search Subscriptions Request

Defines parameters in a SearchSubscriptions endpoint request.

Structure

SearchSubscriptionsRequest

Fields

Name	Type	Tags	Description	Getter	Setter
cursor	?string	Optional	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. For more information, see Pagination.	getCursor(): ?string	setCursor(?string cursor): void
limit	?int	Optional	The upper limit on the number of subscriptions to return in the response. Default: 200	getLimit(): ?int	setLimit(?int limit): void
query	?SearchSubscriptionsQuery	Optional	Represents a query (including filtering criteria) used to search for subscriptions.	getQuery(): ?SearchSubscriptionsQuery	setQuery(?SearchSubscriptionsQuery query): void

Example (as JSON)

{
  "query": {
    "filter": {
      "location_ids": [
        "S8GWD5R9QB376"
      ],
      "customer_ids": [
        "CHFGVKYY8RSV93M5KCYTG4PN0G"
      ]
    }
  }
}