cancelOrder( )

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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
function cancelOrder(
  _id: string,
  effectiveAt: CancellationEffectiveAt,
): Promise<void>;
Method Parameters
_idstringRequired

Order ID.

effectiveAtCancellationEffectiveAtRequired

Required. When the order will be canceled. One-time orders can only be canceled IMMEDIATELY.

JavaScript
import { orders } from "@wix/pricing-plans";

async function cancelOrder(id, effectiveAt) {
  const response = await orders.cancelOrder(id, effectiveAt);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?