Skip to main content
GET
Get retention offers
Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization
string
header
required

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

subscriptionId
string<uuid>
required

The unique identifier of the subscription.

Response

The retention configuration for this subscription.

enabled
boolean

Whether retention offers are switched on for the organization. When false, every reason has offer: null.

writtenFeedback
object

Whether to ask the customer for a free-text comment, and the question to show. Pass the answer as cancellationComment when cancelling.

reasons
object[]

One entry per cancellation reason, in a fixed order.