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 purchase.

Only users with "Manage Pricing Plans" permissions can update plans.

Method Declaration
Copy
function updatePlan(planInfo: UpdatePlanInfo): Promise<Plan>;
Method Parameters
planInfoUpdatePlanInfoRequired

The information for the plan being updated.

Returns
Return Type:Promise<Plan>
Update a plan
JavaScript
/******************************* * Backend code - plans.web.js * *******************************/ import { Permissions, webMethod } from "wix-web-module"; import wixPricingPlansBackend from "wix-pricing-plans-backend"; export const myUpdatePlanFunction = webMethod( Permissions.Anyone, (planInfo) => { return wixPricingPlansBackend.updatePlan(planInfo); }, ); /************* * Page code * *************/ import { myUpdatePlanFunction } from "backend/plans.web"; // … const planInfo = { _id: "3743d382-a4d4-7e15-ada5-340ad4b5d760", name: "Gold Plus", description: "Updated description for the original Gold plan", maxPurchasesPerBuyer: 1, primary: false, public: false, termsAndConditions: "", }; myUpdatePlanFunction(planInfo) .then((plan) => { // plan updated const planId = plan._id; const description = plan.description; }) .catch((error) => { // plan not updated const updateError = error; }); /* Full plan object: * * { * "_id": "3743d382-a4d4-7e15-ada5-340ad4b5d760", * "name": "Gold Plus", * "description": "Updated description for the original Gold plan", * "perks": [ * "Multiplayer", * "Multiple devices", * "No ads", * "Unlimited access" * ], * "pricing": { * "price": { * "value": "10.00", * "currency": "USD" * }, * "singlePaymentUnlimited": true * }, * "public": false, * "archived": false, * "primary": false, * "hasOrders": false, * "_createdDate": "2020-12-21T09:38:14.939Z", * "_updatedDate": "2020-12-30T09:09:10.939Z", * "slug": "gold-plus", * "maxPurchasesPerBuyer": 1, * "allowFutureStartDate": true, * "buyerCanCancel": true, * "termsAndConditions": "" * } */
Errors

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

Did this help?