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.
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.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function cancelOrder(
_id: string,
effectiveAt: CancellationEffectiveAt,
): Promise<void>;Order ID.
Required. When the order will be canceled. One-time orders can only be canceled IMMEDIATELY.
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 */This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.