Sign in

v1

latestOpenAPI 3.0.32026-07-132534113.7 KB
Cancel Flow

Submit Cancel Flow Response

Submits the user's responses from the cancel flow, including survey answers and the final outcome (cancelled, retained, dismissed, or paused). Used for cancel flow analytics.

post/iap/cancel-flow/respond

Request body

user_idstring required

The user's external ID.

product_idstring

The product being cancelled.

outcome'cancelled' | 'retained' | 'dismissed' | 'paused' required

The final outcome of the cancel flow.

offer_shownboolean

Whether a retention offer was shown to the user.

offer_acceptedboolean

Whether the user accepted the retention offer.

pause_shownboolean

Whether a pause option was shown.

pause_acceptedboolean

Whether the user chose to pause.

pause_duration_daysinteger

Number of days the user chose to pause, if applicable.

last_step_seenstring

The last step of the cancel flow the user saw.

variant_idinteger

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

Response

Response recorded

statusstring

Example response

{
  "status": "ok"
}