requestCancellation( )


Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.

There may be some operations that continue to be processed before the status of the order is changed to "CANCELED". For example, payments might need to be refunded before the order is fully 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 won't be billed. The buyer may continue using the benefits until the end of the free trial period.

Note: This method requires visitor or member authentication.

Method Declaration
Copy
Method Parameters
_idstringRequired

Order ID.


effectiveAtCancellationEffectiveAtRequired

Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.

Did this help?