> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Method name: archivePlan(id: string)

# Method package: wixPricingPlansBackend

# Method menu location: wixPricingPlansBackend --> archivePlan

# Method Link: https://dev.wix.com/docs/velo/apis/wix-pricing-plans-backend/archive-plan.md

# Method Description:

Archives a single pricing plan.

The `archivePlan()` function returns a promise that resolves to the newly-archived plan.

 When a plan is archived, the plan: 
 + Is no longer available for display or selection by visitors. This is because 
   the plan's `visibility` property is automatically set to `false`. 
 + Cannot be purchased.
 + Cannot be "un-archived" (meaning, the plan cannot be made active again).

 Plan archiving does not impact existing purchases made for the plan. All purchases for the 
 plan are still active and keep their payment options and terms.

 Site owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.

 Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can archive plans.

 > **Note:** An attempt to archive an already-archived plan throws an error.



# Method Code Examples:

*** Note: do not assume any prop names or enum values other than the ones in the example.

## Archive a plan

```javascript
import { Permissions, webMethod } from 'wix-web-module';
import wixPricingPlansBackend from 'wix-pricing-plans-backend';

export const myArchivePlanFunction = webMethod(Permissions.Anyone, () => {
  const planId = '411a5551-b0f6-4826-8a41-ebae2879f857';
  return wixPricingPlansBackend.archivePlan(planId)
    .then((plan) => {
      const archivedPlanId = plan._id;
      console.log(archivedPlanId);
    })
    .catch((error) => {
      console.error(error);
    });
});

/* Returns a promise that resolves to a plan object for the archived plan:
 *
 * {
 *  "plan": {
 *    "_id": "411a5551-b0f6-4826-8a41-ebae2879f857",
 *    "name": "Gold",
 *    "description": "Gold membership to the MyGame World of Online Gaming",
 *    "perks": [ 
 *      "Multiplayer", 
 *      "Multiple devices", 
 *      "No ads",
 *      "Unlimited access" 
 *    ],
 *    "pricing": {
 *      "subscription": {
 *        "cycleDuration": {
 *          "count": 1,
 *          "unit": "WEEK"
 *        },
 *        "cycleCount": 1
 *      },
 *      "price": {
 *        "value": "15",
 *        "currency": "USD"
 *      }
 *    },
 *    "public": false,
 *    "archived": true,
 *    "primary": false,
 *    "hasOrders": false,
 *    "_createdDate": "2020-12-21T15:13:09.492Z",
 *    "_updatedDate": "2020-12-30T08:02:14.867Z",
 *    "slug": "gold",
 *    "allowFutureStartDate": false,
 *    "buyerCanCancel": true,
 *    "termsAndConditions": "No sharing access with others!"
 * }
 */
```

---