> ## Documentation Index > Fetch the complete documentation index at: https://developers.appstle.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. **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 ## OpenAPI ````yaml /memberships/admin-api-swagger.json get /api/external/v2/cancellation-managements/{id} openapi: 3.0.1 info: description: >- Comprehensive API documentation for managing memberships, payments, and related operations. These APIs allow you to programmatically manage membership lifecycles, handle payments, configure products, and integrate membership functionality into your applications. title: Admin APIs version: 0.0.1 servers: - url: https://membership-admin.appstle.com security: [] tags: - description: >- APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships name: Shipping & Delivery Profiles - description: >- APIs for retrieving historical discount code usage and redemption information for membership contracts name: Customer Discount History - description: >- APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens name: Cancellation Flow Configuration - description: >- APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping name: Billing & Orders - description: >- APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items name: One-Time Add-Ons - description: >- APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans name: Membership Plans - description: >- APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes name: Product Bundles - description: >- APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization name: Custom CSS Styling - description: >- APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal name: Customer Portal Configuration - description: >- APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations name: Membership Contracts - description: >- APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options name: Bundle Settings - description: >- APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions name: Customer Payment Methods - description: >- APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups name: Product Swap Rules - description: >- APIs for retrieving product catalog, variants, pricing, and inventory information for subscription memberships. name: Product & Inventory Data - description: >- APIs for managing shop-level membership settings, configuration, and general store information. name: Shop Settings - description: >- APIs for performing bulk/mass operations on multiple membership contracts including status updates, product replacements, and billing date changes. name: Bulk Operations paths: /api/external/v2/cancellation-managements/{id}: get: tags: - Cancellation Flow Configuration summary: Get cancellation flow configuration description: >- 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 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 operationId: getCancellationManagementV2 parameters: - description: Shop identifier (typically shop domain) example: mystore.myshopify.com in: path name: id required: true schema: format: int64 type: integer - description: API Key (Deprecated - Use Header X-API-Key instead) in: query name: api_key required: false schema: type: string - in: header name: X-API-Key required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancellationManagementDTO' description: Cancellation flow configuration successfully retrieved '401': content: '*/*': schema: $ref: '#/components/schemas/CancellationManagementDTO' description: Authentication required - invalid or missing API key '404': content: '*/*': schema: $ref: '#/components/schemas/CancellationManagementDTO' description: Cancellation management configuration not found for shop components: schemas: CancellationManagementDTO: properties: cancellationInstructionsText: description: Custom instructions text shown during cancellation type: string cancellationReasonsJSON: description: JSON array of cancellation reason options presented in the survey type: string cancellationRetentionMessage: description: Retention message shown to discourage cancellation type: string cancellationType: description: Type of cancellation flow to present to customers enum: - CANCEL_IMMEDIATELY - CANCELLATION_INSTRUCTIONS - CUSTOMER_RETENTION_FLOW type: string discountRecurringCycleLimit: description: Number of billing cycles the retention discount applies to format: int32 type: integer dynamicallyPauseCycleOnCancellation: type: boolean id: description: Unique identifier of the cancellation management config example: 101 format: int64 type: integer pauseDurationCycle: description: Number of billing cycles to pause when pause option is selected format: int32 type: integer shop: description: Shop domain identifier example: my-store.myshopify.com type: string required: - shop type: object ````