POST

Search Plans


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.categoryIdsSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
pricingVariants.nameSearch: ✗
Aggregate:
Sort: ASC, DESC
$hasAll, $hasSome
_createdDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte
_idSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
_updatedDateSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte
formIdSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
nameSearch:
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
slugSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
termsAndConditionsSearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith
visibilitySearch: ✗
Aggregate:
Sort: ASC, DESC
$eq, $ne, $in, $exists
tags.privateTags.tagIdsSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
tags.publicTags.tagIdsSearch: ✗
Aggregate:
Sort: ✗
$hasAll, $hasSome
Permissions
Read Orders
Read Pricing Plans
Learn more about app permissions.
Method Declaration
Copy
Errors

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

Did this help?