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.
| Property | Capabilities | Filters |
|---|---|---|
pricingVariants.pricingStrategies.flatRate.amount | Search: ✗ Aggregate: ✓ Sort: ✗ | $hasAll, $hasSome |
pricingVariants._id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
pricingVariants.name | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $hasAll, $hasSome |
_createdDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
_id | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
_updatedDate | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte |
formId | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
name | Search: ✓ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
slug | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte |
visibility | Search: ✗ Aggregate: ✓ Sort: ASC, DESC | $eq, $ne, $exists, $in, $any |
Search options. See API Query Language for more details.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.