requestCancellation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Starts the process of canceling an order.

The requestCancellation() function returns a Promise that resolves when the order cancellation is successfully requested.

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 after the request is processed.

Requesting an order cancellation starts the cancellation process. 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.

Method Declaration
Method Parameters

Order ID.

3 enum supported values:

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

Supported values:

  • "IMMEDIATELY": Indicates that the order should be canceled immediately.
  • "NEXT_PAYMENT_DATE": Indicates that the order be canceled at the next payment date.
Was this helpful?