POST

Query Plans


Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of plans, given the provided paging, filtering, and sorting. Query plans runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • cursorPaging.limit is 100

To learn about working with queries, see API Query Language.

PropertyFiltersSort
pricingVariants.pricingStrategies.flatRate.amount$hasSome, $hasAllNone
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
visibility$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
formId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
pricingVariants._id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
pricingVariants.name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
slug$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
termsAndConditions$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
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?