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:
"CANCELED".The onOrderCanceled() event handler runs when an order is canceled.
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
can cancel orders. You can override the permissions by setting the function's suppressAuth
option to true.
ID of the order to cancel.
When the order is canceled. One-time orders can only be canceled immediately. Supported values:
"IMMEDIATELY". The order is canceled immediately."NEXT_PAYMENT_DATE". The order is canceled at the next payment date.Options to use when canceling an order.