updatePlan( )

Updates a pricing plan.

The updatePlan() function returns a Promise that resolves to an updated plan.

Updating a plan does not impact existing purchases made for the plan. All purchases keep the details of the original plan that was active at the time of the purchase.

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
Method Parameters

ID of the plan to update.

Return Type:Promise<Plan>
Was this helpful?