Cancel Flow

Get Cancel Flow

Changed on

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

Request

  • Base URL
    https://api.zerosettle.io/v1
  • URL
    https://api.zerosettle.io/v1/iap/cancel-flow
  • Auth
    API key in header X-ZeroSettle-Key

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.

Changes