updatePlan( )

Updates a pricing plan. Updating a plan doesn't impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of purchase.

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 updatePlan(_id: string, plan: UpdatePlan): Promise<Plan>;
Method Parameters
_idstringRequired

ID of the plan to update.

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

async function updatePlan(id, plan) {
  const response = await plans.updatePlan(id, plan);
}
Errors

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

Did this help?