searchPlans( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of plans that match the provided search query and optionally performs aggregations on the data queried.

To learn about working with queries, see Search, Query and List Methods.

PropertyCapabilitiesFilters
pricingVariants.pricingStrategies.flatRate.amountSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
pricingVariants._idSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
pricingVariants.nameSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
_createdDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
_idSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
_updatedDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte
formIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
nameSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
slugSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
termsAndConditionsSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte
visibilitySearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $exists, $in, $any
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

Search options. See API Query Language for more details.

Returns
Return Type:Promise<SearchPlansResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?