> 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: cancelOrder(orderId: string, effectiveAt: string, options: Options)

# Method package: wixPricingPlansBackend

# Method menu location: wixPricingPlansBackend --> Orders --> cancelOrder

# Method Link: https://dev.wix.com/docs/velo/apis/wix-pricing-plans-backend/orders/cancel-order.md

# Method Description:

Cancels an existing order.

The `cancelOrder()` function returns a Promise that resolves when the order is successfully canceled.

 For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
 For orders with one-time payments, a cancellation occurs `IMMEDIATELY`.

 Canceling an order causes the following changes:
 + The order status changes to `"CANCELED"`.

 The [`onOrderCanceled()`](wix-pricing-plans-backend/events/onOrderCanceled) event handler runs when an order is canceled.

 #### Canceling during the free trial period

 When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
 of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
 of the free trial period.

 When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation
 `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` ends the subscription for the buyer
 immediately, even during the free trial period and the buyer won't be billed. Canceling at the
 `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
 Then, the subscription ends and the buyer is not billed.

 > **Note**: Only site visitors with the **Manage Pricing Plans** and **Manage Subscriptions** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions/roles)
 > can cancel orders. You can override the permissions by setting the function's `suppressAuth`
 > option to `true`.



# Method Code Examples:

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

## Cancel an order at a later date

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

// Sample orderId value: 'a8c4a1b2-b5e8-4b33-9693-057ec93e9a27'
// 
// Sample effectiveAt value: 'NEXT_PAYMENT_DATE'

export const myCancelOrderFunction = webMethod(Permissions.Anyone, async (orderId, effectiveAt) => {
  try {
    const order = await orders.cancelOrder(orderId, effectiveAt);

    return order;
  } catch (error) {
    console.error(error);
  }
});

// Returns a promise that resolves to void
```

## Cancel an order immediately, bypassing permission checks

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

/* Sample orderId value: 'a8c4a1b2-b5e8-4b33-9693-057ec93e9a27'
 * 
 * Sample effectiveAt value: 'IMMEDIATELY'
 * 
 * Sample options value:
 * {
 *   suppressAuth: true
 * }
 */

export const myCancelOrderWithOptionsFunction = webMethod(Permissions.Anyone, async (orderId, effectiveAt, options) => {
  try {
    const order = await orders.cancelOrder(orderId, effectiveAt, options);

    return order;
  } catch (error) {
    console.error(error);
  }
});

// Returns a promise that resolves to void
```

---