listPlans( )


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 up to 100 pricing plans (including public, hidden, and archived plans).

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Pricing Plans
Read Pricing Plans
Learn more about app permissions.
Method Declaration
Copy
function listPlans(options: ListPlansOptions): Promise<ListPlansResponse>;
Method Parameters
optionsListPlansOptions

Options for filtering and paging the list of plans.

Returns
Return Type:Promise<ListPlansResponse>
JavaScript
import { plans } from "@wix/pricing-plans"; async function listPlans(options) { const response = await plans.listPlans(options); }
Errors

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

Did this help?