Cancellation Flow Configuration
Get cancellation flow settings
Retrieves the cancellation management configuration including retention offers, cancellation reasons, and survey settings.
GET
Get cancellation flow settings
Path Parameters
Response
200 - */*
OK
Shop domain identifier
Example:
"my-store.myshopify.com"
Custom instructions text shown during cancellation
JSON array of cancellation reason options presented in the survey
Retention message shown to discourage cancellation
Type of cancellation flow to present to customers
Available options:
CANCEL_IMMEDIATELY, CANCELLATION_INSTRUCTIONS, CUSTOMER_RETENTION_FLOW Number of billing cycles the retention discount applies to
Unique identifier of the cancellation management config
Example:
101
Number of billing cycles to pause when pause option is selected