> 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 # ResumeOrder # Package: pricingPlans # Namespace: OrderManagementService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/orders/resume-order.md ## Permission Scopes: Manage Orders: SCOPE.DC-PAIDPLANS.MANAGE-ORDERS ## Introduction Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule. Resuming an order causes the following changes: - The order status changes to `"ACTIVE"`. - The `pausePeriods` array is updated. - The `endDate` for the order is adjusted to include the pause period. - For orders with recurring payments, the payment schedule is restarted. - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use). To pause an order, call Pause Order. --- ## REST API ### Schema ``` Method: resumeOrder Description: Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule. Resuming an order causes the following changes: - The order status changes to `"ACTIVE"`. - The `pausePeriods` array is updated. - The `endDate` for the order is adjusted to include the pause period. - For orders with recurring payments, the payment schedule is restarted. - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use). To pause an order, call Pause Order. URL: https://www.wixapis.com/pricing-plans/v2/orders/{id}/resume Method: POST Return type: ResumeOrderResponse EMPTY-OBJECT {} ``` ### Examples ### ResumeOrder ```curl ~~~cURL curl -X POST \ 'https://www.wixapis.com/pricing-plans/v2/orders/9e2f0450-f8ab-4459-a4a9-a851ebbd12d1/resume' \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.pricingPlans.OrderManagementService.resumeOrder(_id) Description: Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule. Resuming an order causes the following changes: - The order status changes to `"ACTIVE"`. - The `pausePeriods` array is updated. - The `endDate` for the order is adjusted to include the pause period. - For orders with recurring payments, the payment schedule is restarted. - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use). To pause an order, call Pause Order. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: _id Method parameters: param name: _id | type: string | description: Order GUID. | required: true Return type: PROMISE EMPTY-OBJECT {} ``` ### Examples ### Resume paused orders by a member (with $w) Page code provides button list of active orders for a logged-in member. Member selects paused plan and submits `#resumeOrderBtn` to resume the order. `#orderSelection` and `resumeOrderBtn` are initially disabled. ```javascript /********************************** * Backend code - order.web.js/ts * *********************************/ import { Permissions, webMethod } from '@wix/web-methods'; import { orders } from '@wix/pricing-plans'; import { auth } from '@wix/essentials'; const elevatedResumeOrder = auth.elevate(orders.resumeOrder); export const getPausedMemberOrders = webMethod( Permissions.Anyone, async () => { try { const options = { orderStatuses: 'PAUSED' }; const result = await orders.memberListOrders(options); const getPausedMemberOrders = result.orders; return result; } catch (error) { console.error(error); // Handle the error } }); export const resumeOrder = webMethod( Permissions.Anyone, async (orderId) => { try { await elevatedResumeOrder(orderId); return; } catch (error) { console.error(error); // Handle the error } }); /************* * Page code * *************/ import { getPausedMemberOrders, resumeOrder } from 'backend/order.web'; $w.onReady(function () { let selectedOrderId; populateOrderButtonList(); $w('#orderSelection').onChange(() => { selectedOrderId = $w('#orderSelection').value; $w('#resumeOrderBtn').enable(); }); $w('#resumeOrderBtn').onClick(async () => { await resumeOrder(selectedOrderId); }); }); async function populateOrderButtonList() { const pausedOrders = await getPausedMemberOrders(); $w('#pausedOrders').options = pausedOrders.orders.map(item => { return { label: item.planName, value: item._id } }); $w('#pausedOrders').show(); } ``` ### Resume an order (with elevated permissions) ```javascript import { orders } from '@wix/pricing-plans'; import { auth } from '@wix/essentials'; /* Sample _id value: '9af3cbe6-fe27-4fdb-a0b0-892289b03d22' */ const elevatedResumeOrder = auth.elevate(orders.resumeOrder); export async function myResumeOrderFunction(_id) { try { await elevatedResumeOrder(_id); return; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to void */ ``` ### Resume an order ```javascript import { orders } from '@wix/pricing-plans'; /* Sample _id value: '9af3cbe6-fe27-4fdb-a0b0-892289b03d22' */ export async function myResumeOrderFunction(_id) { try { await orders.resumeOrder(_id); return; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to void */ ``` ### resumeOrder (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { orders } from '@wix/pricing-plans'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { orders }, // Include the auth strategy and host as relevant }); async function resumeOrder(_id) { const response = await myWixClient.orders.resumeOrder(_id); }; ``` ---