APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships
External (0.0.1)
Download OpenAPI description
Languages
Servers
https://membership-admin.appstle.com
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
- https://membership-admin.appstle.com/api/external/v2/cancellation-managements/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Response
application/json
{ "id": 0, "shop": "string", "cancellationType": "CANCEL_IMMEDIATELY", "cancellationInstructionsText": "string", "cancellationReasonsJSON": "string", "cancellationRetentionMessage": "string", "pauseDurationCycle": 0, "dynamicallyPauseCycleOnCancellation": true, "discountRecurringCycleLimit": 0 }