Retrieves the cancellation management settings for the shop, controlling how members cancel subscriptions. These settings define the cancellation experience including retention offers, surveys, and confirmation flows.
Key Configuration Returned:
Cancellation Flow Elements:
Retention Offer Configuration:
Use Cases:
Common Cancellation Reasons:
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
curl --request GET \
--url https://membership-admin.appstle.com/api/external/v2/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.
Shop identifier (typically shop domain)
API Key (Deprecated - Use Header X-API-Key instead)
Cancellation flow configuration successfully retrieved
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://membership-admin.appstle.com/api/external/v2/cancellation-managements/{id}{
"shop": "my-store.myshopify.com",
"id": 101,
"cancellationInstructionsText": "<string>",
"cancellationReasonsJSON": "<string>",
"cancellationRetentionMessage": "<string>",
"pauseDurationCycle": 123,
"dynamicallyPauseCycleOnCancellation": true,
"discountRecurringCycleLimit": 123
}