v1

latestOpenAPI 3.0.32026-07-132534113.7 KB

Cancel Flow

Get Cancel Flow

Returns the configured cancel flow for the app, including survey questions, retention offers, and pause options. The SDK uses this to render a multi-step cancellation experience.

get/iap/cancel-flow

Query parameters

user_idstring

The user's external ID. Used to personalize offers.

Response

Cancel flow configuration

enabledboolean

Whether the cancel flow is enabled for this app.

variant_idinteger nullable

Experiment variant ID if the cancel flow is part of an A/B test.