getPlanStats( )


Retrieves statistics about the pricing plans.

The getPlanStats() function returns a Promise that resolves to statistics about the plan on the site.

Currently this function provides only the total number of pricing plans, including 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
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<GetPlanStatsResponse>
Was this helpful?
Yes
No