> 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(_id: string, effectiveAt: CancellationEffectiveAt)

# Method package: wixPricingPlansV2

# Method menu location: wixPricingPlansV2 --> orders --> cancelOrder

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

# Method Description:

Cancels an existing order.

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 can only be set for `IMMEDIATELY`.

#### 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 Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
`IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end 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.



# Method Code Examples:

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

## Cancel an order immediately (dashboard page code)

```javascript
import { orders } from 'wix-pricing-plans.v2';
import { elevate } from 'wix-auth';

/* Sample _id value: 'e6f12ae0-2618-41e7-a643-31ca2ee51e2b'
 *
 * Sample effectiveAt value: 'IMMEDIATELY'
 */

const elevatedCancelOrder = elevate(orders.cancelOrder);

export async function myCancelOrderFunction(_id, effectiveAt) {
  try {
    await elevatedCancelOrder(_id, effectiveAt);

    return;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}

/* Promise resolves to void */  
```

## Cancel an order immediately (export from backend code)

```javascript
import { Permissions, webMethod } from 'wix-web-module';
import { orders } from 'wix-pricing-plans.v2';
import { elevate } from 'wix-auth';

/* 
 * Sample _id value: 'e6f12ae0-2618-41e7-a643-31ca2ee51e2b'
 *
 * Sample effectiveAt value: 'IMMEDIATELY'
 */

const elevatedCancelOrder = elevate(orders.cancelOrder);

export const myCancelOrderFunction = webMethod(Permissions.Anyone, async (_id, effectiveAt) => {
  try {
    await elevatedCancelOrder(_id, effectiveAt);

    return;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});

/* Promise resolves to void */

```

---