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.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Pricing Plans
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

ID of the plan to update.


planUpdatePlanRequired

optionsUpdatePlanOptions

Options for updating the plan.

Returns
Return Type:Promise<Plan>
Did this help?