Cancels an active collections payment promise. Cancelling does not resume the invoice's reminder sequence.
A promise can also end automatically. When the invoice is paid, the promise becomes fulfilled or broken. When the invoice is voided, written off, or deleted, the promise becomes cancelled.
Sample Request
Sample Result[JSON]
URL Format
POST https://[site].chargebee.com/api/v2/collections_payment_promises/{collections-payment-promise-id}/cancel
Returns
Collections payment promise object
The updated collections_payment_promise resource after cancellation.