Skip to main content
GET
Get cancellation flow settings

Path Parameters

id
integer<int64>
required

Response

200 - */*

OK

shop
string
required

Shop domain identifier

Example:

"my-store.myshopify.com"

cancellationInstructionsText
string

Custom instructions text shown during cancellation

cancellationReasonsJSON
string

JSON array of cancellation reason options presented in the survey

cancellationRetentionMessage
string

Retention message shown to discourage cancellation

cancellationType
enum<string>

Type of cancellation flow to present to customers

Available options:
CANCEL_IMMEDIATELY,
CANCELLATION_INSTRUCTIONS,
CUSTOMER_RETENTION_FLOW
discountRecurringCycleLimit
integer<int32>

Number of billing cycles the retention discount applies to

dynamicallyPauseCycleOnCancellation
boolean
id
integer<int64>

Unique identifier of the cancellation management config

Example:

101

pauseDurationCycle
integer<int32>

Number of billing cycles to pause when pause option is selected