Get cancellation flow configuration

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.

Full behavior, validation rules, and side effects

Key Configuration Returned:

• Cancellation Reasons: Predefined list of reasons members can select
• Retention Offers: Discounts or perks offered to prevent cancellations
• Survey Questions: Custom questions to gather cancellation feedback
• Confirmation Settings: Text and buttons for cancel confirmation screen
• Minimum Cycle Requirements: Enforce minimum subscription duration before canceling
• Win-Back Campaigns: Settings for re-engagement after cancellation
• Plan-Specific Rules: Different cancellation flows per membership plan

Cancellation Flow Elements:

• Reason Selection: Dropdown/radio options for why member is canceling
• Feedback Collection: Open-text fields for additional comments
• Retention Step: Show special offers before final cancellation
• Alternative Options: Pause, skip, or frequency change suggestions
• Confirmation Screen: Final confirmation with cancel button text
• Email Notifications: Trigger cancellation confirmation emails

Retention Offer Configuration:

• Discount percentage or fixed amount off
• Number of cycles the retention discount applies
• Eligibility rules (new members only, all members, etc.)
• Display message and call-to-action text
• Success/failure handling

Use Cases:

• Build custom cancellation flows in member portals
• Display retention offers programmatically
• Integrate cancellation reasons with analytics platforms
• Customize cancel experience per membership tier
• Show plan-specific retention messaging
• Enforce business rules around cancellations

Common Cancellation Reasons:

• Too expensive
• No longer need the product
• Delivery issues
• Product quality concerns
• Switching to competitor
• Moving/relocating

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

GET /api/external/v2/cancellation-managements/{id}

Get cancellation flow configuration

cURL

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/cancellation-managements/{id}

200

{
  "shop": "my-store.myshopify.com",
  "id": 101,
  "cancellationInstructionsText": "<string>",
  "cancellationReasonsJSON": "<string>",
  "cancellationRetentionMessage": "<string>",
  "pauseDurationCycle": 123,
  "dynamicallyPauseCycleOnCancellation": true,
  "discountRecurringCycleLimit": 123
}

Headers

X-API-Key · string

Path Parameters

id · integer<int64> · required

Shop identifier (typically shop domain)

Query Parameters

api_key · string

API Key (Deprecated - Use Header X-API-Key instead)

Response

200

application/json

Cancellation flow configuration successfully retrieved

shop · string · required

Shop domain identifier

Example:

"my-store.myshopify.com"

id · integer<int64>

Unique identifier of the cancellation management config

Example:

101

cancellationType · enum<string>

Type of cancellation flow to present to customers

Available options: CANCEL_IMMEDIATELY, CANCELLATION_INSTRUCTIONS, CUSTOMER_RETENTION_FLOW

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

pauseDurationCycle · integer<int32>

Number of billing cycles to pause when pause option is selected

dynamicallyPauseCycleOnCancellation · boolean

discountRecurringCycleLimit · integer<int32>

Number of billing cycles the retention discount applies to