Skip to content
👤 Customer Portal APIs
/
/
Cancel a membership contr...

Customer Portal APIs (0.0.1)

Important Note:

The APIs in this document are for reference only and will not work directly in Swagger. To use these APIs, you need to call them from your shop.

The base URL for these APIs is your shop's domain. For example, if your shop domain is https://www.myshop.com/apps, then the full API endpoint will be based on this domain (e.g., https://www.myshop.com/apps/memberships/cp/api/**).

Please ensure the customer is logged in when calling the Customer Portal Proxy API. If the customer is not logged in, the API will return a 401 Unauthorized error.

Download OpenAPI description
storefront-api-swagger.json
storefront-api-swagger.yaml
Languages
Servers
https://www.myshop.com/apps

Shipping & Delivery Profiles

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

Operations

Custom CSS Styling

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

Operations

Customer Discount History

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

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

Cancellation Flow Configuration

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

Operations

Membership Contracts

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

Operations

getCurrentCycleOfSubscriptionContract

Request

Path
contractIdinteger(int64)required
curl -i -X GET \
  'https://www.myshop.com/apps/memberships/cp/api/subscription-contract-details/current-cycle/{contractId}'

Responses

OK

Body*/*
integer(int32)

Cancel a membership contract

Request

Permanently cancels an active membership contract in Shopify. This operation stops all future billing and marks the membership as CANCELLED.

Important Notes:

  • Permanent Action: Cancellation cannot be undone. A new membership must be created to re-subscribe.
  • Email Notification: Cancellation email is automatically sent to the customer
  • Activity Logging: Cancellation is logged with reason/feedback for analytics
  • Immediate Effect: No future billing attempts will be made

Customer Portal Restrictions: When called from customer portal, additional validations apply:

  • Minimum Cycles: Cannot cancel if membership hasn't completed minimum required billing cycles
  • Frozen Memberships: Cannot cancel memberships that are frozen until min cycle completion
  • Attribute-Based Limits: Respects any custom attribute-based cancellation restrictions

Cancellation Feedback:

  • Optional cancellationFeedback parameter to capture why customer is cancelling
  • Common values: 'TOO_EXPENSIVE', 'NO_LONGER_NEEDED', 'SWITCHING_TO_COMPETITOR', 'OTHER'
  • Helps merchants understand churn reasons

Use Cases:

  • Customer requests to cancel their membership
  • Merchant manually cancels membership (e.g., payment issues, customer request)
  • Automated cancellation after max cycles reached

Authentication: Requires authenticated shop user or customer portal token

Path
idinteger(int64)required

Membership contract ID to cancel

Example: 123456789
Query
cancellationFeedbackstring

Optional cancellation reason/feedback from customer

Example: cancellationFeedback=TOO_EXPENSIVE
cancellationNotestring

Optional cancellation note with additional details

Example: cancellationNote=Customer found a cheaper alternative
curl -i -X DELETE \
  'https://www.myshop.com/apps/memberships/cp/api/subscription-contracts/123456789?cancellationFeedback=TOO_EXPENSIVE&cancellationNote=Customer+found+a+cheaper+alternative'

Responses

Membership successfully cancelled (no content returned). Cancellation email sent to customer.

Response
No content

Billing & Orders

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

Operations

Product & Inventory Data

APIs for retrieving product catalog, variants, pricing, and inventory information for subscription memberships

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 Swap Rules

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

Operations

loyalty-integration-resource

Operations

customer-retention-activity-resource

Operations

shop-info-resource

Operations