Skip to content
/
Cancellation Flow Configu...

External (0.0.1)

Download OpenAPI description
admin-api-swagger.json
admin-api-swagger.yaml
Languages
Servers
https://membership-admin.appstle.com

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Get cancellation flow configuration

Request

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

Path
idinteger(int64)required

Shop identifier (typically shop domain)

Example: mystore.myshopify.com
Query
api_keystring

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

Headers
X-API-Keystring
curl -i -X GET \
  'https://membership-admin.appstle.com/api/external/v2/cancellation-managements/mystore.myshopify.com?api_key=string' \
  -H 'X-API-Key: string'

Responses

Cancellation flow configuration successfully retrieved

Bodyapplication/json
idinteger(int64)
shopstringrequired
cancellationTypestring
Enum"CANCEL_IMMEDIATELY""CANCELLATION_INSTRUCTIONS""CUSTOMER_RETENTION_FLOW"
cancellationInstructionsTextstring
cancellationReasonsJSONstring
cancellationRetentionMessagestring
pauseDurationCycleinteger(int32)
dynamicallyPauseCycleOnCancellationboolean
discountRecurringCycleLimitinteger(int32)
Response
application/json
{
  "id": 0,
  "shop": "string",
  "cancellationType": "CANCEL_IMMEDIATELY",
  "cancellationInstructionsText": "string",
  "cancellationReasonsJSON": "string",
  "cancellationRetentionMessage": "string",
  "pauseDurationCycle": 0,
  "dynamicallyPauseCycleOnCancellation": true,
  "discountRecurringCycleLimit": 0
}

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Bundles

APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes

Operations

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Bundle Settings

APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options

Operations

Customer Payment Methods

APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions

Operations

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

Subscription Contract Management

Operations

Subscription Billing

Operations

Billing Attempts

Operations