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 pricing plans.

The listPlans() function returns a Promise that resolves to a list of up to 100 pricing plans. This includes public, hidden, and archived plans.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Pricing Plans
Manage Pricing Plans
Learn more about permission scopes.
Method Declaration
Method Parameters

Options for filtering and paging the list of plans.

Return Type:Promise<ListPlansResponse>
Was this helpful?