makePlanPrimary( )

Marks a pricing plan as the primary pricing plan. When viewing pricing plans on a site, the primary plan is highlighted with a customizable ribbon. Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling Make Plan Primary causes the existing primary plan to lose its primary status.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Pricing Plans
Learn more about app permissions.
Method Declaration
Copy
function makePlanPrimary(_id: string): Promise<MakePlanPrimaryResponse>;
Method Parameters
_idstringRequired

ID of the pricing plan to set as the primary plan.

Returns
Return Type:Promise<MakePlanPrimaryResponse>
JavaScript
import { plans } from "@wix/pricing-plans";

async function makePlanPrimary(id) {
  const response = await plans.makePlanPrimary(id);
}
Errors

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

Did this help?