clearPrimary( )

Sets all pricing plans to no longer be primary.

The clearPrimary() function returns a Promise that is resolved when there are no pricing plans marked as primary.

After clearing the primary plan, when viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.

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:
Manage Pricing Plans
Learn more about permission scopes.
Method Declaration
This method does not take any parameters
Was this helpful?