Skip to main content
GET
Retrieve a cancel flow session

Path Parameters

Example Request

Response

The status field can be one of in_progress, completed, cancelled, or saved. A status of saved indicates the customer accepted a retention offer and did not cancel.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Response

The session.

id
string<uuid>
tenant_id
string<uuid>
customer_id
string<uuid>
subscription_id
string<uuid>
flow_id
string<uuid>
status
enum<string>
Available options:
in_progress,
completed,
cancelled,
saved
current_step_index
integer
cancellation_reason
string
feedback
string
offer_presented
any

The retention offer shown, if any (arbitrary JSON).

offer_accepted
boolean
saved_by_offer
boolean
started_at
string<date-time>
completed_at
string<date-time> | null