Retrieves the customer portal configuration and settings for the authenticated shop. The customer portal is the self-service interface where subscribers can manage their subscriptions, update payment methods, modify delivery addresses, and more.
What is the Customer Portal? The customer portal is a dedicated web interface that allows your subscribers to manage their subscription accounts independently. This reduces support burden and improves customer experience by enabling self-service subscription management.
Settings Returned:
Display Configuration:
Feature Toggles:
Subscription Management Options:
Communication Settings:
Access Control:
Advanced Options:
Use Cases:
Important Notes:
Common Configuration Scenarios:
1. Standard Self-Service Portal:
2. Locked-Down Portal (Minimal Self-Service):
3. Full-Service Portal (Maximum Flexibility):
Authentication: Requires valid X-API-Key header
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/customer-portal-settings/{id}{
"id": 12345,
"shop": "example-shop.myshopify.com",
"portalEnabled": true,
"customDomain": "subscriptions.example.com",
"allowPause": true,
"maxPauseDuration": 90,
"allowSkip": true,
"maxConsecutiveSkips": 2,
"allowFrequencyChange": true,
"allowQuantityChange": true,
"allowProductSwap": true,
"allowAddressEdit": true,
"allowPaymentMethodUpdate": true,
"allowCancellation": true,
"requireCancellationReason": true,
"enableOneTimeProducts": true,
"minimumSubscriptionCycles": 3,
"theme": {
"primaryColor": "#4A90E2",
"secondaryColor": "#50E3C2",
"accentColor": "#F5A623",
"fontFamily": "'Helvetica Neue', Arial, sans-serif",
"logoUrl": "https://cdn.shopify.com/s/files/1/0000/0000/files/logo.png",
"customCss": ".subscription-card { border-radius: 8px; }"
},
"authentication": {
"method": "MAGIC_LINK",
"sessionDuration": 3600,
"requireEmailVerification": true
},
"notifications": {
"sendSkipConfirmation": true,
"sendPauseConfirmation": true,
"sendFrequencyChangeConfirmation": true,
"sendCancellationConfirmation": true
},
"supportContact": {
"email": "support@example.com",
"phone": "+1-800-123-4567",
"chatEnabled": true
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-02-20T14:45:00Z"
}Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Customer portal settings successfully retrieved
ALL_PRODUCTS, PRODUCTS_FROM_ALL_PLANS, PRODUCTS_FROM_CURRENT_PLAN PERCENTAGE, AMOUNT NONE, EXISTING_PLAN, PRODUCT_PLAN, PRODUCT_THEN_EXISTING Show child attributes
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/customer-portal-settings/{id}{
"id": 12345,
"shop": "example-shop.myshopify.com",
"portalEnabled": true,
"customDomain": "subscriptions.example.com",
"allowPause": true,
"maxPauseDuration": 90,
"allowSkip": true,
"maxConsecutiveSkips": 2,
"allowFrequencyChange": true,
"allowQuantityChange": true,
"allowProductSwap": true,
"allowAddressEdit": true,
"allowPaymentMethodUpdate": true,
"allowCancellation": true,
"requireCancellationReason": true,
"enableOneTimeProducts": true,
"minimumSubscriptionCycles": 3,
"theme": {
"primaryColor": "#4A90E2",
"secondaryColor": "#50E3C2",
"accentColor": "#F5A623",
"fontFamily": "'Helvetica Neue', Arial, sans-serif",
"logoUrl": "https://cdn.shopify.com/s/files/1/0000/0000/files/logo.png",
"customCss": ".subscription-card { border-radius: 8px; }"
},
"authentication": {
"method": "MAGIC_LINK",
"sessionDuration": 3600,
"requireEmailVerification": true
},
"notifications": {
"sendSkipConfirmation": true,
"sendPauseConfirmation": true,
"sendFrequencyChangeConfirmation": true,
"sendCancellationConfirmation": true
},
"supportContact": {
"email": "support@example.com",
"phone": "+1-800-123-4567",
"chatEnabled": true
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-02-20T14:45:00Z"
}