> ## Documentation Index > Fetch the complete documentation index at: https://developers.appstle.com/llms.txt > Use this file to discover all available pages before exploring further. # Get customer portal settings > 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**: - Portal theme and branding settings - Custom colors and logo - Layout preferences - Custom CSS selectors - **Feature Toggles**: - Enable/disable subscription pausing - Enable/disable order skipping - Enable/disable product swapping - Enable/disable frequency changes - Enable/disable quantity modifications - Enable/disable address editing - Enable/disable payment method updates - Enable/disable subscription cancellation - **Subscription Management Options**: - Maximum pause duration allowed - Minimum subscription duration requirements - Skip limits per billing cycle - Product swap availability - One-time product add-ons - **Communication Settings**: - Email notification preferences - Custom portal messaging - Support contact information - Help text and instructions - **Access Control**: - Portal authentication method - Password requirements - Magic link settings - Session duration - **Advanced Options**: - Custom domain configuration - Redirect URLs - Webhook endpoints - Analytics tracking settings **Use Cases:** - Display customer portal with correct branding and theme - Determine which features are available to subscribers - Build custom portal interfaces using your settings - Sync portal configuration across systems - Validate subscription management capabilities - Configure third-party integrations **Important Notes:** - Settings are shop-specific and unique per merchant - Some features may be restricted based on subscription plan - Changes to settings are reflected immediately in the portal - Custom CSS must be valid and secure - Portal URL is typically: shop-domain.com/apps/subscriptions **Common Configuration Scenarios:** **1. Standard Self-Service Portal:** - Allow pausing (up to 3 months) - Allow skipping (max 2 consecutive orders) - Allow frequency changes - Allow quantity updates - Allow address editing - Enable payment method updates - Enable cancellation with feedback **2. Locked-Down Portal (Minimal Self-Service):** - Disable pausing - Disable skipping - Disable cancellation (require support contact) - Allow address editing only - Allow payment method updates only **3. Full-Service Portal (Maximum Flexibility):** - Enable all subscription management features - Allow unlimited pauses and skips - Enable product swapping - Enable one-time add-ons - Allow subscription splitting/merging - Custom branding and domain **Authentication:** Requires valid X-API-Key header ## OpenAPI ````yaml /subscription/storefront-api-swagger.json get /subscriptions/cp/api/customer-portal-settings/{id} openapi: 3.0.1 info: description: >- Comprehensive API documentation for the customer-facing subscription portal. These APIs enable customers to manage their subscriptions, update billing information, modify delivery schedules, and access their account details through your storefront. **Important**: These APIs must be called from your shop's domain (e.g., https://www.myshop.com/apps/subscriptions/cp/api/**) and require customer authentication. Unauthenticated requests will return a 401 Unauthorized error. title: Storefront APIs version: 0.0.1 servers: - url: https://www.myshop.com/apps security: [] tags: - description: >- Core customer portal APIs for managing customer account settings, authentication, and portal configurations. name: Customer Portal - description: >- APIs for customers to view and manage their subscription contracts including status updates, frequency changes, and cancellations. name: Subscription Management - description: >- APIs for retrieving and updating subscription contract details — delivery schedules, line items, addresses, billing cycles. name: Subscription Contracts - description: >- APIs for retrieving available subscription plans and selling plan configurations exposed to customers. name: Subscription Plans - description: >- APIs for managing one-time add-on products that can be purchased alongside recurring subscription items. name: Subscription One-Time Products - description: >- APIs for retrieving aggregated subscription data and account-level subscription information for the signed-in customer. name: Subscription Data - description: >- APIs for managing customizable product boxes and bundles where customers can select multiple items. name: Build-a-Box & Bundles - description: >- APIs for managing payment methods, billing information, and processing subscription payments. name: Billing & Payments - description: >- APIs for retrieving product information, selling plans, variant data, and subscription-enabled products available to customers. name: Product Catalog - description: >- APIs for managing delivery schedules, shipping addresses, delivery methods, and tracking order status. name: Delivery & Shipping - description: >- APIs for handling subscription cancellations, retention activities, and customer feedback management. name: Customer Retention - description: >- APIs for integrating loyalty programs with subscriptions including points redemption and earning options. name: Loyalty Integration - description: >- APIs for accessing portal customization settings, translations, and theme configurations. name: Customization - description: >- APIs for retrieving promotional campaigns shown in the customer portal, tracking banner engagement, and redeeming campaign offers. name: Campaigns - description: >- APIs for local pickup and click-and-collect — listing pickup locations and resolving eligible pickup dates and time slots. name: Store Pickup paths: /subscriptions/cp/api/customer-portal-settings/{id}: get: tags: - Customization - Customer Portal summary: Get customer portal settings description: >- 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**: - Portal theme and branding settings - Custom colors and logo - Layout preferences - Custom CSS selectors - **Feature Toggles**: - Enable/disable subscription pausing - Enable/disable order skipping - Enable/disable product swapping - Enable/disable frequency changes - Enable/disable quantity modifications - Enable/disable address editing - Enable/disable payment method updates - Enable/disable subscription cancellation - **Subscription Management Options**: - Maximum pause duration allowed - Minimum subscription duration requirements - Skip limits per billing cycle - Product swap availability - One-time product add-ons - **Communication Settings**: - Email notification preferences - Custom portal messaging - Support contact information - Help text and instructions - **Access Control**: - Portal authentication method - Password requirements - Magic link settings - Session duration - **Advanced Options**: - Custom domain configuration - Redirect URLs - Webhook endpoints - Analytics tracking settings **Use Cases:** - Display customer portal with correct branding and theme - Determine which features are available to subscribers - Build custom portal interfaces using your settings - Sync portal configuration across systems - Validate subscription management capabilities - Configure third-party integrations **Important Notes:** - Settings are shop-specific and unique per merchant - Some features may be restricted based on subscription plan - Changes to settings are reflected immediately in the portal - Custom CSS must be valid and secure - Portal URL is typically: shop-domain.com/apps/subscriptions **Common Configuration Scenarios:** **1. Standard Self-Service Portal:** - Allow pausing (up to 3 months) - Allow skipping (max 2 consecutive orders) - Allow frequency changes - Allow quantity updates - Allow address editing - Enable payment method updates - Enable cancellation with feedback **2. Locked-Down Portal (Minimal Self-Service):** - Disable pausing - Disable skipping - Disable cancellation (require support contact) - Allow address editing only - Allow payment method updates only **3. Full-Service Portal (Maximum Flexibility):** - Enable all subscription management features - Allow unlimited pauses and skips - Enable product swapping - Enable one-time add-ons - Allow subscription splitting/merging - Custom branding and domain **Authentication:** Requires valid X-API-Key header operationId: getCustomerPortalSettings parameters: - in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: Success Response: description: Success Response value: allowAddressEdit: true allowCancellation: true allowFrequencyChange: true allowPause: true allowPaymentMethodUpdate: true allowProductSwap: true allowQuantityChange: true allowSkip: true authentication: method: MAGIC_LINK requireEmailVerification: true sessionDuration: 3600 createdAt: '2024-01-15T10:30:00Z' customDomain: subscriptions.example.com enableOneTimeProducts: true id: 12345 maxConsecutiveSkips: 2 maxPauseDuration: 90 minimumSubscriptionCycles: 3 notifications: sendCancellationConfirmation: true sendFrequencyChangeConfirmation: true sendPauseConfirmation: true sendSkipConfirmation: true portalEnabled: true requireCancellationReason: true shop: example-shop.myshopify.com supportContact: chatEnabled: true email: support@example.com phone: +1-800-123-4567 theme: accentColor: '#F5A623' customCss: '.subscription-card { border-radius: 8px; }' fontFamily: '''Helvetica Neue'', Arial, sans-serif' logoUrl: >- https://cdn.shopify.com/s/files/1/0000/0000/files/logo.png primaryColor: '#4A90E2' secondaryColor: '#50E3C2' updatedAt: '2024-02-20T14:45:00Z' schema: $ref: '#/components/schemas/CustomerPortalSettingsDTO' description: Customer portal settings successfully retrieved '401': content: application/json: example: detail: Valid X-API-Key header is required status: 401 title: Authentication required type: https://example.com/errors/unauthorized description: Authentication required '403': content: application/json: example: detail: API key does not have permission to view portal settings status: 403 title: Insufficient permissions type: https://example.com/errors/forbidden description: Insufficient permissions to view customer portal settings '404': content: application/json: example: detail: >- Customer portal settings have not been configured for this shop status: 404 title: Settings not found type: https://example.com/errors/not-found description: >- Customer portal settings not found - Settings may not be initialized yet components: schemas: CustomerPortalSettingsDTO: properties: activeBadgeText: type: string addAdditionalProduct: type: boolean addAdditionalProductInBAB: type: boolean addDiscountCodeAlertText: type: string addDiscountCodeText: type: string addNewButtonText: type: string addOneTimeProduct: type: boolean addProductButtonText: type: string addProductFinishedMessageText: type: string addProductLabelText: type: string addToOrderLabelText: type: string addToSubscriptionDiscriptionTextV2: type: string addToSubscriptionTitleCP: type: string address1LabelText: type: string address2LabelText: type: string addressHeaderTitleText: type: string afterCycleDiscountNoteDescription: type: string aiAgentEnabled: type: boolean aiAgentTier: type: string allowAddOneTimeProductOrderIdPrepaid: type: boolean allowAddRemoveSwapBeforeDays: type: string allowCancelDuringFreeTrial: type: boolean allowCancellationBeforeDays: type: string allowDiscountCodeBeforeMinOrders: type: boolean allowEditQuantityPrepaidSeparatePlan: type: boolean allowOnlyOneTimeProductOnAddProductFlag: type: boolean allowOrderNow: type: boolean allowProductIdsForSubscriptionProductAdd: type: string allowProductTagsForSubscriptionProductAdd: type: string allowReschedulingContractTrialPeriod: type: boolean allowSplitContract: type: boolean allowSwapWhenContractIsFreeze: type: boolean allowToAddProductQuantityMinMaxReached: type: boolean allowToAutoAddProduct: type: boolean allowToEditQuantityIfProductOutOfStock: type: boolean allowToEditQuantityInSingleBABProduct: type: boolean allowToSameReasonAgain: type: boolean allowToSpecificZipCode: type: string allowToSpecificZipCodeForLocalDelivery: type: string allowedProductIdsForOneTimeProductAdd: type: string amountLbl: type: string amountTieredDiscountText: type: string applySellingPlanBasedDiscount: type: boolean applySubscriptionDiscount: type: boolean applySubscriptionDiscountForOtp: type: boolean areyousureCommonMessageText: type: string areyousurePauseMessageText: type: string areyousureResumeMessageText: type: string attributeHeadingText: type: string attributeNameLabelText: type: string attributeValue: type: string babProductBadgeTextV2: type: string billingDateRestrictFromDate: type: string billingDateRestrictToDays: format: int32 type: integer bottomHtml: type: string cancelAccordionTitle: type: string cancelButtonText: type: string cancelChangeOrderBtnText: type: string cancelEditShippingButtonText: type: string cancelFreqBtnText: type: string cancelSub: type: boolean cancelSubscriptionBtnText: type: string cancelSubscriptionConfirmPayAsYouGoText: type: string cancelSubscriptionConfirmPrepaidText: type: string cancelSubscriptionMinimumBillingIterationsMessage: type: string cancelSubscriptionPayAsYouGoButtonText: type: string cancelSubscriptionPrepaidButtonText: type: string cancellationDateTitleText: type: string cancellationNoteTitleText: type: string cardExpiryText: type: string cardHolderNameText: type: string cardLastFourDigitText: type: string cardTypeText: type: string changeAddressMessageOnPause: type: string changeDateMessageOnPause: type: string changeNextOrderDate: type: boolean changeOrderFrequency: type: boolean changePaymentMessage: type: string changeShippingAddressFlag: type: boolean changeVariantLabelText: type: string chooseAnotherPaymentMethodTitleText: type: string chooseDifferentProductActionText: type: string chooseDifferentProductText: type: string choosePurchaseOptionLabelText: type: string cityLabelText: type: string clickHereText: type: string closeBadgeText: type: string closeBtnText: type: string companyLabelText: type: string confirmAddProduct: type: string confirmCommonText: type: string confirmSkipFulfillmentBtnText: type: string confirmSkipOrder: type: string confirmSwapText: type: string continueText: type: string contractCancelledBadgeText: type: string contractErrorMessageText: type: string contractUpdateMessageText: type: string countryCodeLabelText: type: string countryLabelText: type: string createAdditionalOrder: type: boolean creditCardText: type: string customJs: type: string customerIdText: type: string customerPortalLandingPage: type: string customerPortalSettingJson: type: string dateFormat: type: string dayText: type: string deleteButtonText: type: string deleteConfirmationMsgText: type: string deleteMsgText: type: string deleteOneTimePurchaseProduct: type: boolean deleteProductFlag: type: boolean deleteProductTitleText: type: string deliveryFrequencyText: type: string deliveryPriceText: type: string disAllowProductIdsForOneTimeProductAdd: type: string disAllowProductTagsForSubscriptionProductAdd: type: string disAllowVariantIdsForOneTimeProductAdd: type: string disAllowVariantIdsForSubscriptionProductAdd: type: string disableRescheduleTimeSelector: type: boolean disabledKeyFieldFlag: type: boolean discountAccordionTitle: type: string discountAppliedTextV2: type: string discountCarryForward: enum: - NONE - EXISTING_PLAN - PRODUCT_PLAN - PRODUCT_THEN_EXISTING type: string discountCode: type: boolean discountCodeApplyButtonText: type: string discountCodeText: type: string discountCouponAppliedText: type: string discountCouponNotAppliedText: type: string discountCouponRemoveText: type: string discountDetailsTitleText: type: string discountMessageOnCancellation: type: string discountMessageOnPause: type: string discountNoteTitle: type: string discountPercentageOnCancellation: type: string discountRecurringCycleLimitOnCancellation: type: string displayCountryByLanguage: type: boolean editChangeOrderBtnText: type: string editCommonText: type: string editDeliveryInternalText: type: string editFrequencyBtnText: type: string editProductButtonText: type: string editProductFlag: type: boolean editQuantityLabelText: type: string emailAddressText: type: string emailMagicLinkText: type: string enableAllowOnlyOneDiscountCode: type: boolean enableEditAttributes: type: boolean enableEditOrderNotes: type: boolean enableMergeContract: type: boolean enableProductDescription: type: boolean enableRedirectMyAccountButton: type: boolean enableRedirectToProductPage: type: boolean enableSkipFulFillment: type: boolean enableSkipIndividualProduct: type: boolean enableSplitContract: type: boolean enableSwapProductFeature: type: boolean enableSwapProductVariant: type: boolean enableTabletForceView: type: boolean enableUpdateDeliveryMethod: type: boolean enableUpsellProducts: type: boolean enableViewAttributes: type: boolean endingWithText: type: string everyLabelText: type: string expiredTokenText: type: string failureText: type: string filterDeliveryFrequencyOnCustomerTags: type: boolean finishLabelText: type: string firstNameLabelText: type: string freezeOrderTillMinCycle: type: boolean freezeUpdateSubscriptionMessage: type: string frequencyChangeWarningDescription: type: string frequencyChangeWarningTitle: type: string fromDeliveryDateAddDay: format: int32 type: integer fulfilledText: type: string giftMessageOnPause: type: string goBackButtonText: type: string goBackRedirectLink: type: string greetingText: type: string hasBeenRemovedText: type: string helloNameText: type: string hideAddSubscriptionProductSection: type: boolean hideAttributeAddition: type: boolean hideDetailsText: type: string hideHistoryTabNewCp: type: boolean hideLoyaltyTable: type: boolean hidePaymentMethodEdit: type: boolean hideResumeButtonWhenMaxCycleReached: type: boolean hideSchedulesTabNewCp: type: boolean historyTabHeaderHTML: type: string historyTabTitle: type: string id: format: int64 type: integer includeOutOfStockProduct: type: boolean initialDiscountNoteDescription: type: string lastNameLabelText: type: string localeDate: type: string magicLinkEmailFlag: type: boolean manageSubscriptionButtonText: type: string maxCycleText: type: string maxIterationReachedText: type: string minCycleText: type: string minProductsInSubscriptionContract: type: string minQtyToAllowDuringAddProduct: format: int32 type: integer monthText: type: string multiCurrencyAvailable: type: boolean nextBtnText: type: string nextDeliveryDate: type: string nextOrderDateLbl: type: string nextOrderText: type: string nextTierAmountTieredDiscountText: type: string nextTierPercentageTieredDiscountText: type: string noBtnText: type: string noDeliveryMethodLabelText: type: string noOrderNotAvailableMessage: type: string noSubscriptionMessage: type: string offerDiscountOnCancellation: type: boolean oneTimePurchaseDisplayMessageText: type: string oneTimePurchaseMessageText: type: string oneTimePurchaseNoteText: type: string oneTimePurchaseOnlyText: type: string oneTimePurchaseTitleCP: type: string openBadgeText: type: string orderDateText: type: string orderFrequencyText: type: string orderNoLbl: type: string orderNoteFlag: type: boolean orderNoteText: type: string orderNowDescriptionText: type: string orderNowText: type: string orderTotalText: type: string overrideDaysToRescheduleOrder: type: boolean pauseAccordionTitle: type: string pauseBadgeText: type: string pauseMessageOnPause: type: string pauseNoteTitleText: type: string pauseResumeSub: type: boolean pauseSubscriptionText: type: string pauseTillDateTitleText: type: string paymentDetailAccordionTitle: type: string paymentInfoText: type: string paymentMethodTypeText: type: string paymentNotificationText: type: string paypalLblText: type: string percentageTieredDiscountText: type: string phoneLabelText: type: string pleaseSelectText: type: string pleaseWaitLoaderText: type: string popUpErrorMessage: type: string popUpSuccessMessage: type: string portalLoginLinkText: type: string preventAddRemoveSwapBeforeDays: type: string preventCancellationBeforeDays: type: string preventCancellationBeforeDaysMessage: type: string preventChildProductSwap: type: boolean previousBtnText: type: string priceLbl: type: string productAddMessageText: type: string productFilterConfig: type: string productInSubscriptionText: type: string productLabelText: type: string productLblText: type: string productRemovedTooltip: type: string productSelectionOption: enum: - ALL_PRODUCTS - PRODUCTS_FROM_ALL_PLANS - PRODUCTS_FROM_CURRENT_PLAN type: string provinceCodeLabelText: type: string provinceLabelText: type: string purchaseOptionLabelText: type: string quantityLbl: type: string queueBadgeText: type: string redeemRewardsTextV2: type: string removeDiscountCodeAlertText: type: string removeDiscountCodeAutomatically: type: boolean removeDiscountCodeLabel: type: string removeSwapSourceProductLimit: type: boolean requireFieldMessage: type: string rescheduleOrderDescription: type: string rescheduleText: type: string reschedulingPolicies: type: string resumeSub: type: boolean resumeSubAfterCancellation: type: boolean resumeSubscriptionText: type: string retriveMagicLinkText: type: string retryFailedOrderConfirmationTextV2: type: string retryFailedOrderDescriptionTextV2: type: string rewardsTextV2: type: string saveButtonText: type: string scheduledTabTitle: type: string schedulesTabHeaderHTML: type: string searchProductBtnText: type: string sectionMinMaxTextV2: type: string sectionTitleText: type: string sectionedBabBadgeText: type: string seeMoreDetailsText: type: string seeMoreProductBtnText: type: string selectCancellationReasonLabelText: type: string selectPaymentMethodTitleText: type: string selectProductLabelText: type: string selectProductToAdd: type: string selectSplitMethodLabelText: type: string selectedCancellationReasonTitleText: type: string selectedPauseReasonTitleText: type: string selectedProductLabelTextV2: type: string sellingPlanFrequencyOptionMode: enum: - LEGACY_UNION - COMPATIBLE_ONLY type: string sellingPlanNameText: type: string sendEmailText: type: string shippingAddressNotAvailableText: type: string shippingLabelText: type: string shippingOptionText: type: string shop: type: string shopCustomizationData: items: $ref: '#/components/schemas/UpdateShopCustomizationRequest' type: array shopPayLblText: type: string shopPayPaymentUpdateText: type: string showNextOrderDeliveryDate: type: boolean showSellingPlanFrequencies: type: boolean showShipment: type: boolean singleBABDeletedProductPlaceholderImage: type: string skipBadgeText: type: string skipDaysFromCurrentDate: format: int32 type: integer skipDaysToCurrentDate: format: int32 type: integer skipFulfillmentButtonText: type: string skipMessageOnPause: type: string skipOrderButtonText: type: string splitContractConfirmButtonText: type: string splitContractMessage: type: string splitContractNoteText: type: string splitContractText: type: string splitWithOrderPlacedSelectOptionHelpText: type: string splitWithOrderPlacedSelectOptionText: type: string splitWithoutOrderPlacedSelectOptionHelpText: type: string splitWithoutOrderPlacedSelectOptionText: type: string statusLbl: type: string statusText: type: string subTotalLabelText: type: string subscriptionActivatedMessageText: type: string subscriptionContractFreezeMessage: type: string subscriptionDiscount: format: double type: number subscriptionDiscountTypeUnit: enum: - PERCENTAGE - AMOUNT type: string subscriptionNoText: type: string subscriptionPausedMessageText: type: string successText: type: string swapMessageOnPause: type: string swapProductBtnText: type: string swapProductLabelText: type: string swapProductSearchBarText: type: string toDeliveryDateAddDay: format: int32 type: integer topHtml: type: string totalLblText: type: string totalPricePerDeliveryText: type: string totalProductsText: type: string unableToUpdateSubscriptionStatusMessageText: type: string unknownPaymentReachoutUsText: type: string upSellMessage: type: string upcomingFulfillmentText: type: string upcomingOrderAccordionTitle: type: string upcomingOrderChangePopupFailureClosebtnText: type: string upcomingOrderChangePopupFailureDescriptionText: type: string upcomingOrderChangePopupFailureTitleText: type: string upcomingOrderChangePopupSuccessClosebtnText: type: string upcomingOrderChangePopupSuccessDescriptionText: type: string upcomingOrderChangePopupSuccessTitleText: type: string upcomingOrderPlaceNowAlertText: type: string upcomingOrderSkipAlertText: type: string upcomingTabHeaderHTML: type: string upcomingTabTitle: type: string updateButtonText: type: string updateChangeOrderBtnText: type: string updateEditShippingButtonText: type: string updateFreqBtnText: type: string updateFrequencyMessageOnPause: type: string updatePaymentBtnText: type: string updatePaymentMessage: type: string updatePaymentMethodTitleText: type: string updateShipmentBillingDate: type: boolean useUrlWithCustomerId: type: boolean validEmailMessage: type: string validNumberRequiredMessage: type: string variantIdsToFreezeEditRemove: type: string variantLbl: type: string variantLblText: type: string viewAttributeLabelText: type: string viewMoreText: type: string weekText: type: string welcomeText: type: string yearText: type: string yesBtnText: type: string yourAvailableRewardsPointsTextV2: type: string yourRewardsTextV2: type: string zipLabelText: type: string required: - amountLbl - cancelAccordionTitle - cancelFreqBtnText - cancelSubscriptionBtnText - cardExpiryText - cardHolderNameText - cardLastFourDigitText - cardTypeText - editFrequencyBtnText - nextOrderDateLbl - nextOrderText - noSubscriptionMessage - orderFrequencyText - orderNoLbl - paymentDetailAccordionTitle - paymentInfoText - paymentMethodTypeText - quantityLbl - shop - statusLbl - statusText - subscriptionNoText - totalProductsText - upcomingOrderAccordionTitle - updateFreqBtnText - updatePaymentBtnText - updatePaymentMessage type: object UpdateShopCustomizationRequest: properties: id: format: int64 type: integer labelId: format: int64 type: integer value: type: string type: object ````