External APIs (0.0.1)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Hides multiple subscription contracts from customer view in bulk. This operation allows merchants to quickly hide subscriptions from appearing in the customer portal without canceling or deleting them.

What Does 'Hide' Mean? Hiding a subscription makes it invisible to customers in their customer portal while keeping the subscription data intact. The subscription is not deleted or canceled - it's simply hidden from the customer's view. This is useful for:

• Temporarily removing subscriptions from customer access
• Managing test or dummy subscriptions
• Handling subscription disputes or issues
• Preparing subscriptions for migration or cleanup

Key Features:

• Bulk Operation: Process multiple subscriptions in a single request
• Non-Destructive: Subscriptions are hidden, not deleted
• Reversible: Hidden subscriptions can be unhidden later
• Asynchronous Processing: Large batches are processed in the background
• Conflict Detection: Prevents multiple simultaneous bulk operations

Operation Modes:

1. Specific Subscriptions: Provide a list of subscription contract IDs to hide
2. All Subscriptions: Set allSubscriptions=true to hide all active subscriptions (use with caution)

How It Works:

1. Submit a request with subscription IDs or allSubscriptions flag
2. System validates the subscription IDs belong to your shop
3. A bulk automation task is created and queued
4. Each subscription is marked as hidden
5. Subscriptions disappear from customer portal immediately
6. Subscriptions remain in merchant admin for management

Request Body Structure:

{
  "subscriptionIds": [
    "gid://shopify/SubscriptionContract/123456",
    "gid://shopify/SubscriptionContract/123457",
    "gid://shopify/SubscriptionContract/123458"
  ]
}

Use Cases:

• Subscription Cleanup: Hide test or duplicate subscriptions created during setup
• Customer Service: Temporarily hide problematic subscriptions while resolving issues
• Migration Preparation: Hide old subscriptions before migrating to new plans
• Dispute Management: Hide subscriptions involved in billing disputes
• Seasonal Management: Hide seasonal subscriptions during off-season
• Batch Processing: Clean up subscriptions that meet certain criteria

Important Notes:

• Only one bulk operation can run at a time per shop
• If a bulk operation is already in progress, the request will fail with 400 error
• Subscription IDs must be in Shopify GraphQL ID format (gid://shopify/SubscriptionContract/xxxxx)
• Hidden subscriptions stop appearing in customer portal but remain active for billing
• You can unhide subscriptions later through the admin interface
• Using allSubscriptions=true will hide ALL subscriptions - use with extreme caution

Processing Time:

• Small batches (<100): Usually complete within seconds
• Medium batches (100-1000): May take 1-2 minutes
• Large batches (>1000): May take several minutes to hours
• Progress can be tracked through the bulk automation status endpoint

Best Practices:

• Always specify exact subscription IDs rather than using allSubscriptions=true
• Test with a small batch first before processing large numbers
• Keep track of hidden subscription IDs for future reference
• Document the reason for hiding subscriptions for audit purposes
• Monitor bulk operation status to ensure completion
• Consider notifying customers before hiding their subscriptions

Workflow Example:

1. Identify subscriptions to hide (e.g., test subscriptions with specific tags)
2. Extract their subscription contract IDs
3. Call this endpoint with the list of IDs
4. Verify 204 No Content response indicating successful queue
5. Monitor processing status through admin or status endpoint
6. Confirm subscriptions are hidden from customer portal

Error Scenarios:

• Another bulk operation is running: 400 error with message about operation in progress
• Invalid subscription IDs: Silently skips invalid IDs, processes valid ones
• Unauthorized subscription access: Only subscriptions belonging to your shop are processed
• Empty subscription list: Operation completes successfully with no action

Authentication: Requires valid api_key parameter (X-API-Key header support coming soon)

Retrieves the cancellation management and retention settings for the authenticated shop. These settings control the subscription cancellation flow, retention strategies, and customer feedback collection when subscribers attempt to cancel their subscriptions.

What is Cancellation Management? Cancellation management is a retention system that helps merchants reduce subscription churn by understanding why customers cancel and offering alternatives before they leave. It includes cancellation flows, feedback collection, retention offers (discounts, pauses, frequency changes), and automated win-back strategies.

Configuration Components:

1. Cancellation Flow Settings:

• Enable/disable self-service cancellation in customer portal
• Require customer to contact support for cancellation
• Multi-step cancellation confirmation process
• Cancellation cooldown period (prevent accidental cancellations)
• Minimum subscription duration before cancellation allowed
• Immediate vs. end-of-billing-cycle cancellation

2. Cancellation Reasons & Feedback:

• Predefined cancellation reasons list
• Custom cancellation reason options
• Required vs. optional feedback
• Free-form text feedback field
• Rating/satisfaction scale
• Exit survey questions
• Feedback sent to merchant email/dashboard

Common Cancellation Reasons:

• Too expensive / Can't afford
• Don't use product enough / Have too much inventory
• Product quality issues
• Switching to competitor
• Delivery issues / Shipping problems
• Forgot to cancel earlier
• Temporary pause needed (moving, travel, etc.)
• Product doesn't meet expectations
• Customer service issues
• Other (with text field)

3. Retention Offers (Save Flow):

• Display retention offers before final cancellation
• Offer discount (percentage or fixed amount)
• Offer free product/gift with next order
• Suggest subscription pause instead of cancel
• Suggest frequency change (deliver less often)
• Offer to skip next order
• Offer to swap products
• Personalized offers based on cancellation reason

Example Retention Logic:

Reason: "Too expensive"
  → Offer: 20% discount for next 3 months
  → Offer: Switch to smaller/cheaper variant

Reason: "Have too much inventory"
  → Offer: Pause for 1-3 months
  → Offer: Change from monthly to every 2 months
  → Offer: Skip next 2 deliveries

Reason: "Product quality issues"
  → Offer: Free replacement on next order
  → Offer: Try different product variant
  → Route to customer support

4. UI/UX Configuration:

• Cancellation button placement and styling
• Warning messages and modal dialogs
• Progress indicator for multi-step flow
• Retention offer presentation (modal, inline, etc.)
• Confirmation messages
• Post-cancellation survey

5. Automation & Notifications:

• Send cancellation confirmation email
• Notify merchant of cancellations
• Trigger win-back email campaigns
• Schedule feedback review
• Alert for high cancellation rate
• Integration with CRM/analytics tools

6. Metrics & Analytics:

• Track cancellation rate
• Categorize cancellation reasons
• Measure retention offer acceptance rate
• Calculate customer lifetime value at cancellation
• Identify churn patterns and trends
• A/B test different retention strategies

7. Advanced Features:

• Conditional retention offers based on:
  • Customer lifetime value
  • Subscription duration
  • Product type
  • Cancellation history
  • Customer segment
• Win-back campaigns for cancelled subscribers
• Automatic re-engagement emails (30, 60, 90 days post-cancel)
• Special offers to reactivate cancelled subscriptions

Cancellation Flow Examples:

Basic Flow (No Retention):

1. Customer clicks "Cancel Subscription"
2. Confirmation dialog: "Are you sure?"
3. Optional: Select cancellation reason
4. Subscription cancelled immediately or at period end
5. Confirmation email sent

Advanced Retention Flow:

1. Customer clicks "Cancel Subscription"
2. "Before you go..." - Select cancellation reason
3. Display personalized retention offer based on reason
4. Customer chooses: Accept offer OR Continue to cancel
5. If continue: Additional offers or final confirmation
6. If still cancelling: Exit survey
7. Cancellation processed
8. Thank you message + feedback confirmation
9. Follow-up email campaign

Use Cases:

• Configure cancellation flow in customer portal
• Customize retention offers and messaging
• Analyze cancellation patterns and trends
• Build custom cancellation interfaces
• Integrate with customer support tools
• Generate churn reports and analytics
• A/B test different retention strategies
• Automate win-back campaigns

Important Notes:

• Always comply with consumer protection laws regarding cancellation
• Make cancellation process clear and accessible (FTC guidelines)
• Don't make cancellation unnecessarily difficult
• Respect customer's decision to cancel
• Use retention offers ethically (not dark patterns)
• Store cancellation feedback for product improvement
• GDPR/privacy compliance for feedback data

Best Practices:

• Keep cancellation process simple (2-3 steps max)
• Offer genuine value in retention offers
• Personalize offers based on cancellation reason
• Make pause/skip options prominent
• Use cancellation feedback to improve product/service
• Set up automated win-back campaigns
• Monitor cancellation rate and take action on trends
• Train customer support on retention strategies
• Test different retention messaging and offers
• Honor cancellations promptly and professionally

Legal & Compliance:

• FTC regulations require easy cancellation (Click-to-Cancel rule)
• California automatic renewal law compliance
• European consumer protection directives
• Clear disclosure of cancellation terms
• Process cancellations within legal timeframes
• Provide confirmation of cancellation

Authentication: Requires valid X-API-Key header

Retrieves activity logs for all subscription-related events and changes in the authenticated shop. Activity logs provide a comprehensive audit trail of all subscription activities, changes, and system events.

What are Activity Logs? Activity logs are detailed records of every action, event, and change that occurs within your subscription system. They capture who made the change, when it happened, what was changed, and the result of the operation. This provides full traceability and audit capabilities for compliance, debugging, and customer support.

Log Information Captured:

• Entity Information:

  • Entity ID: The specific subscription, billing attempt, or resource affected
  • Entity Type: Type of resource (subscription, billing attempt, plan, settings, etc.)
  • Event Type: Specific action performed (see Event Types below)
  • Event Source: Origin of the event (customer portal, merchant portal, API, system, etc.)

• Event Details:

  • Status: SUCCESS, FAILURE, or INFO
  • Timestamp: When the event occurred
  • Activity By: User or system that triggered the event
  • Client IP: IP address of the requester (if applicable)
  • Additional Info: Detailed JSON payload with before/after values and context

Entity Types:

• SUBSCRIPTION_BILLING_ATTEMPT - Billing and payment attempt events
• SUBSCRIPTION_CONTRACT_DETAILS - Subscription contract modifications
• SUBSCRIPTION_GROUP_PLAN - Subscription plan changes
• SHIPPING_PROFILE - Delivery profile and shipping updates
• CANCELLATION_MANAGEMENT - Subscription cancellation events
• DUNNING_MANAGEMENT - Payment retry and dunning activities
• PRODUCT_SWAP - Product replacement events
• FREQUENCY_SWAP - Billing/delivery frequency changes
• EMAIL_TEMPLATE - Email template modifications
• SHOP_INFO - Shop settings and configuration changes
• SUBSCRIPTION_WIDGET_SETTINGS - Widget configuration updates
• CUSTOMER_PORTAL_SETTINGS - Portal settings modifications
• SUBSCRIPTION_BUNDLING - Bundle and bundling rule changes

Event Sources:

• CUSTOMER_PORTAL - Changes made by subscribers through the customer portal
• MERCHANT_PORTAL - Changes made by merchants in the admin panel
• MERCHANT_EXTERNAL_API - Changes made via API by merchants or integrations
• SHOPIFY_EVENT - Events triggered by Shopify webhooks
• SHOPIFY_FLOW - Events triggered by Shopify Flow automations
• SYSTEM_EVENT - Automated system events (scheduled tasks, sync operations)
• MERCHANT_PORTAL_BULK_AUTOMATION - Bulk operations initiated from admin panel

Common Event Types:

• Subscription Changes: CONTRACT_PAUSED, CONTRACT_ACTIVATED, CONTRACT_CANCELLED, CONTRACT_CREATED
• Product Changes: PRODUCT_ADD, PRODUCT_REMOVE, PRODUCT_REPLACE, PRODUCT_QUANTITY_CHANGE, PRODUCT_PRICE_CHANGE
• Billing Changes: NEXT_BILLING_DATE_CHANGE, BILLING_INTERVAL_CHANGE, BILLING_ATTEMPT_TRIGGERED, BILLING_ATTEMPT_SKIPPED
• Delivery Changes: DELIVERY_INTERVAL_CHANGE, SHIPPING_ADDRESS_CHANGE, DELIVERY_METHOD_UPDATED
• Payment Changes: PAYMENT_METHOD_UPDATED, SWITCH_PAYMENT_METHODS
• Email Events: SEND_UPCOMING_ORDER_EMAIL, SEND_TRANSACTION_FAILED_EMAIL, SEND_SUBSCRIPTION_CREATED_EMAIL
• Discount Events: DISCOUNT_APPLIED, DISCOUNT_REMOVED, PRICING_POLICY_DISCOUNT_APPLIED
• One-Time Products: ONE_TIME_PURCHASE_PRODUCT_ADDED, ONE_TIME_PURCHASE_PRODUCT_REMOVED

Query Parameters and Filtering:

You can filter activity logs using query parameters. All filters support standard operations:

• equals - Exact match
• in - Match any value in list
• greaterThan, lessThan - Date range filtering
• contains - Partial text match

Example Filter Queries:

1. Get all failed billing attempts: ?entityType.equals=SUBSCRIPTION_BILLING_ATTEMPT&eventType.equals=BILLING_ATTEMPT_TRIGGERED&status.equals=FAILURE

2. Get all customer portal changes: ?eventSource.equals=CUSTOMER_PORTAL

3. Get logs for a specific subscription: ?entityId.equals=123456&entityType.equals=SUBSCRIPTION_CONTRACT_DETAILS

4. Get logs within date range: ?createAt.greaterThan=2024-01-01T00:00:00Z&createAt.lessThan=2024-01-31T23:59:59Z

5. Get all cancellation events: ?eventType.equals=CONTRACT_CANCELLED

6. Get all API-triggered changes: ?eventSource.equals=MERCHANT_EXTERNAL_API

Pagination:

Results are paginated. Use standard Spring Data pagination parameters:

• page - Page number (zero-indexed, default: 0)
• size - Page size (default: 20, max: 100)
• sort - Sort criteria (e.g., createAt,desc or id,asc)

Example: ?page=0&size=50&sort=createAt,desc

Use Cases:

• Audit and Compliance: Track all changes for regulatory compliance and internal auditing
• Customer Support: Review subscription history to troubleshoot customer issues
• Debugging: Investigate failed operations and system errors
• Analytics: Analyze customer behavior and subscription lifecycle patterns
• Reporting: Generate reports on subscription changes, cancellations, and modifications
• Integration Monitoring: Track API usage and automated workflow executions
• Security: Monitor for unusual activity patterns or unauthorized changes

Important Notes:

• Activity logs are immutable and cannot be modified or deleted via API
• Logs are retained according to your subscription plan's retention policy
• The additionalInfo field contains detailed JSON with event-specific context
• For large exports, consider using pagination and filtering to reduce data transfer
• Logs are scoped to your shop - you can only access logs for your own subscriptions
• System events may not have an activityBy value as they're automated

Response Headers:

• X-Total-Count - Total number of matching records
• Link - Pagination links (first, last, next, prev)

Authentication: Requires valid api_key query parameter with appropriate permissions