Retrieves the cancellation management configuration including retention offers, cancellation reasons, and survey settings.
curl --request GET \
--url https://www.myshop.com/apps/memberships/cp/api/cancellation-managements/{id}{
"shop": "my-store.myshopify.com",
"id": 101,
"cancellationInstructionsText": "<string>",
"cancellationReasonsJSON": "<string>",
"cancellationRetentionMessage": "<string>",
"pauseDurationCycle": 123,
"dynamicallyPauseCycleOnCancellation": true,
"discountRecurringCycleLimit": 123
}Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
OK
Shop domain identifier
"my-store.myshopify.com"
Unique identifier of the cancellation management config
101
Type of cancellation flow to present to customers
CANCEL_IMMEDIATELY, CANCELLATION_INSTRUCTIONS, CUSTOMER_RETENTION_FLOW Custom instructions text shown during cancellation
JSON array of cancellation reason options presented in the survey
Retention message shown to discourage cancellation
Number of billing cycles to pause when pause option is selected
Number of billing cycles the retention discount applies to
curl --request GET \
--url https://www.myshop.com/apps/memberships/cp/api/cancellation-managements/{id}{
"shop": "my-store.myshopify.com",
"id": 101,
"cancellationInstructionsText": "<string>",
"cancellationReasonsJSON": "<string>",
"cancellationRetentionMessage": "<string>",
"pauseDurationCycle": 123,
"dynamicallyPauseCycleOnCancellation": true,
"discountRecurringCycleLimit": 123
}