This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of plans.
The queryPlans()
method builds a query to retrieve a list of plans and returns a PlansQueryBuilder
object.
The returned object contains the query definition, which is typically used to run the query using the find()
method.
You can refine the query by chaining PlansQueryBuilder
methods onto the query. PlansQueryBuilder
methods enable you to sort, filter, and control the results queryPlans()
returns.
queryPlans()
runs with these PlansQueryBuilder
defaults, which you can override:
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
_createdDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
_updatedDate | eq() ,ne() ,exists() ,in() ,hasSome() ,lt() ,le() ,gt() ,ge() ,ascending() ,descending() |
name | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
slug | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
pricingVariants.id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
pricingVariants.name | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
pricingVariants.pricingStrategies.flatRate.amount | hasSome() ,hasAll() |
visibility | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
formId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.