archivePlan( )


Archives a single plan. When a plan is archived, it's no longer visible as a public plan that can be chosen by site members or visitors. This is because the plan's public property is automatically set to false. Archived plans can't be purchased or reactivated. Plan archiving doesn't impact existing orders made for the plan. All orders for the plan are still active and keep their perks, payment options, and terms. Wix users can see archived plans in a site's dashboard under Pricing Plans -> Archived Plans.

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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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

ID of the active plan to archive.

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