Cancel membership/subscription contract

Cancels a membership/subscription contract and sends cancellation confirmation emails. This endpoint terminates the recurring subscription and processes all cancellation workflows.

Full behavior, validation rules, and side effects

Cancellation Process:

• Contract Termination: Marks subscription as cancelled in Shopify
• Billing Stop: Prevents future billing attempts
• Email Notification: Sends cancellation confirmation to customer
• Activity Logging: Records cancellation event with source and feedback
• Feedback Capture: Optional cancellation reason for analytics

Key Features:

• Immediate Cancellation: Stops subscription processing immediately
• Feedback Collection: Capture customer cancellation reasons
• Automated Emails: Customer receives cancellation confirmation
• Activity Tracking: Logs cancellation to activity history
• Source Attribution: Tracks whether cancellation came from customer portal or API

Validation Checks:

• Contract Ownership: Verifies contract belongs to authenticated shop
• Minimum Cycles: Checks if minimum billing cycles requirement is met (if configured)
• Freeze Status: Validates subscription is not frozen
• Existing Status: Ensures contract is not already cancelled

Email Notifications:

• Sends cancellation confirmation to customer email
• Includes subscription details and cancellation date
• Uses customizable email templates from shop settings

Use Cases:

• Allow customers to cancel from custom portals or mobile apps
• Bulk cancellation workflows via external systems
• Integration with customer service platforms
• Automated cancellation based on business rules
• Churn management and retention workflows

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

DELETE /api/external/v2/subscription-contracts/{id}

Cancel membership/subscription contract

cURL

curl --request DELETE \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contracts/{id}

400

{
  "title": "Bad Request",
  "status": 400,
  "detail": "This membership requires 3 minimum billing cycles before cancellation",
  "errorKey": "min_cycles_not_met"
}

Headers

X-API-Key · string

Path Parameters

id · integer<int64> · required

Membership contract ID to cancel

Query Parameters

api_key · string

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

cancellationFeedback · string

Optional cancellation reason/feedback from customer

Response

204

Subscription successfully cancelled, confirmation email sent