Replied Pass a cancellation reason via the Subscriptions API

[sven-bo]

When a customer cancels through the account dashboard, they can type a cancellation reason, and it then shows up on the subscription in the dashboard.

I cancel subscriptions programmatically via the API (POST /subscription/{id}/cancel). That endpoint only seems to accept cancel_at_end. Is there any way to also send the cancellation reason through the API so it appears on the subscription the same way the dashboard does? Or is that field only available in the dashboard right now?

Thanks,
Sven

 

[Preeti Paryani]

Hello @sven-bo,

Yes, you are correct.

Currently, the Cancel Subscription API endpoint only accepts the cancel_at_end parameter. When a subscription is canceled via the API, the system records that the subscription was canceled through the API, but there is currently no parameter available to pass a cancellation reason.

We have escalated this as a feature request to our development team. If support for passing a cancellation reason via the API is added in the future, we will be sure to update you.

Thank you for bringing this to our attention.