Paddle.Retain.initCancellationFlow()

This example shows how you can use Paddle.Retain.initCancellationFlow() to start a cancellation flow.

subscriptionId is passed to Paddle.Retain.initCancellationFlow() to specify the subscription to cancel.

pwCustomer is passed to Paddle.Initialize() to identify the customer to Paddle Retain, but this is not required. Paddle Retain infers the customer from the subscriptionId passed and presents a cancellation flow.

Retain automatically schedules a cancellation for the subscription in Paddle Billing if a customer proceeds to cancel, so you don't need to build logic to handle this yourself.

1
2
3
4
5
6
7
8
9
10
1<!-- Cancellation button -->
2<button onclick="cancelSubscription();">Cancel my subscription</button>
3
4<script type="text/javascript">
5  function cancelSubscription() {
6    Paddle.Retain.initCancellationFlow({
7      subscriptionId: 'sub_01h8bqcrwp0vjd1p3bv20y7323'
8    });
9  }
10</script>

This example shows how you can attach a callback to a cancellation flow.

It uses the .then() method to attach a callback that logs a message to the console:

• Customer retained!

  The customer accepted a salvage attempt or a salvage offer, or clicked 'Never mind, I don't want to cancel.'

• There was a problem starting the cancellation flow.

  Something went wrong while starting the cancellation flow. The customer was not given the chance to cancel.

• Customer proceeded with cancellation.

  The customer rejected salvage attempts and salvage offers and proceeded to cancel.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1<!-- Cancellation button -->
2<button onclick="cancelSubscription();">Cancel my subscription</button>
3
4<script type="text/javascript">
5  // Cancel subscription 
6  function cancelSubscription() {
7    Paddle.Retain.initCancellationFlow({
8      subscriptionId: 'sub_01h8bqcrwp0vjd1p3bv20y7323'
9    })
10    .then((result) => {
11      if (result.status === 'retained' || result.status === 'aborted') {
12        console.log("Customer retained!");
13      } else if (result.status === 'error') {
14        console.log("There was a problem starting the cancellation flow.");
15      } else {
16        console.log("Customer proceeded with cancellation.");
17      }
18    })
19    .catch((error) => {
20      console.error(error);