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.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function getPlanStats(): Promise<GetPlanStatsResponse>;
import { plans } from "wix-pricing-plans.v2";
export async function myGetPlanStatsFunction() {
try {
const planStats = plans.getPlanStats();
return planStats;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* {
* "totalPlans": 8
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.