Get retention offers
Returns what this subscription can be offered for each cancellation reason, so you can build the cancellation flow in your own app.
Every cancellation reason is listed with the offer configured for it in the Kelviq dashboard retention settings: a discount, a pause, a link to support, or nothing. Each offer carries an eligibility verdict for this particular subscription. An ineligible offer is still returned with ineligibleReason set, so you can show it greyed out with an explanation rather than hide it.
When retention is switched off, enabled is false and every reason comes back with offer: null. The reason list is still returned so the same reason picker can be rendered either way.
To apply the offer the customer chooses, call Accept a retention offer. To record the cancellation instead, call Cancel a subscription with the same cancellationFeedback.
Authorizations
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
Path Parameters
The unique identifier of the subscription.
Response
The retention configuration for this subscription.
Whether retention offers are switched on for the organization. When false, every reason has offer: null.
Whether to ask the customer for a free-text comment, and the question to show. Pass the answer as cancellationComment when cancelling.
One entry per cancellation reason, in a fixed order.