---
title: "Get Cancel Flow"
method: GET
path: "/iap/cancel-flow"
tags: ["Cancel Flow"]
---

# Get Cancel Flow

`GET /iap/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.

## Query parameters

- `user_id` string

## Response `200`

Cancel flow configuration

- CancelFlow — Cancel flow configuration.
  - `enabled` boolean — Whether the cancel flow is enabled for this app.
  - `questions` CancelFlowQuestion[] — Survey questions to show during the cancel flow.
    - `id` string — Question identifier.
    - `text` string — Question text to display.
    - `type` 'single_choice' | 'multiple_choice' | 'free_text' — Question type.
    - `options` object[] — Available answer options (for choice questions).
      - `id` string — Option identifier.
      - `text` string — Option text.
  - `offer` CancelFlowOffer — A retention offer in the cancel flow.
    - `type` 'discount' | 'extension' — Type of retention offer.
    - `discount_percent` integer — Discount percentage (for discount-type offers).
    - `duration_months` integer — How many billing cycles the discount lasts.
    - `title` string — Offer title text.
    - `message` string — Offer body text.
  - `pause` CancelFlowPause — Pause option in the cancel flow.
    - `enabled` boolean — Whether the pause option is available.
    - `duration_days` integer — Default pause duration in days.
    - `max_duration_days` integer — Maximum allowed pause duration.
    - `title` string — Pause option title text.
    - `message` string — Pause option body text.
  - `variant_id` integer, nullable — Experiment variant ID if the cancel flow is part of an A/B test.

## Other responses

- `401` — Invalid or missing API key.

---

[API](https://skmtc.net/zerosettle/apis/zerosettle-iap-api.md) · [All operations](https://skmtc.net/zerosettle/apis/zerosettle-iap-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerosettle/zerosettle-iap-api/versions/1a7aa12f3d5e/schema)