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.

Full behavior, validation rules, and side effects

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

GET /subscriptions/cp/api/customer-portal-settings/{id}

Get customer portal settings

cURL

curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/customer-portal-settings/{id}

200

{
  "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": "[e-mail]",
    "phone": "[phone]",
    "chatEnabled": true
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-02-20T14:45:00Z"
}

Path Parameters

id · string · required

Response

200

application/json

Customer portal settings successfully retrieved

shop · string · required

orderFrequencyText · string · required

totalProductsText · string · required

nextOrderText · string · required

statusText · string · required

cancelSubscriptionBtnText · string · required

noSubscriptionMessage · string · required

subscriptionNoText · string · required

updatePaymentMessage · string · required

cardLastFourDigitText · string · required

cardExpiryText · string · required

cardHolderNameText · string · required

cardTypeText · string · required

paymentMethodTypeText · string · required

cancelAccordionTitle · string · required

paymentDetailAccordionTitle · string · required

upcomingOrderAccordionTitle · string · required

paymentInfoText · string · required

updatePaymentBtnText · string · required

nextOrderDateLbl · string · required

statusLbl · string · required

quantityLbl · string · required

amountLbl · string · required

orderNoLbl · string · required

editFrequencyBtnText · string · required

cancelFreqBtnText · string · required

updateFreqBtnText · string · required

id · integer<int64>

pauseResumeSub · boolean

changeNextOrderDate · boolean

cancelSub · boolean

changeOrderFrequency · boolean

createAdditionalOrder · boolean

manageSubscriptionButtonText · string

editChangeOrderBtnText · string

cancelChangeOrderBtnText · string

updateChangeOrderBtnText · string

editProductButtonText · string

deleteButtonText · string

updateButtonText · string

cancelButtonText · string

addProductButtonText · string

addProductLabelText · string

activeBadgeText · string

closeBadgeText · string

skipOrderButtonText · string

productLabelText · string

seeMoreDetailsText · string

hideDetailsText · string

productInSubscriptionText · string

subTotalLabelText · string

paymentNotificationText · string

editProductFlag · boolean

deleteProductFlag · boolean

showShipment · boolean

magicLinkEmailFlag · boolean

addAdditionalProduct · boolean

successText · string

cancelSubscriptionConfirmPrepaidText · string

cancelSubscriptionConfirmPayAsYouGoText · string

cancelSubscriptionPrepaidButtonText · string

cancelSubscriptionPayAsYouGoButtonText · string

upcomingFulfillmentText · string

creditCardText · string

endingWithText · string

weekText · string

dayText · string

monthText · string

yearText · string

skipBadgeText · string

queueBadgeText · string

shippingLabelText · string

failureText · string

sendEmailText · string

chooseDifferentProductActionText · string

chooseDifferentProductText · string

confirmSkipFulfillmentBtnText · string

confirmSkipOrder · string

skipFulfillmentButtonText · string

confirmCommonText · string

orderNowDescriptionText · string

discountDetailsTitleText · string

emailAddressText · string

emailMagicLinkText · string

retriveMagicLinkText · string

validEmailMessage · string

saveButtonText · string

orderDateText · string

address1LabelText · string

address2LabelText · string

companyLabelText · string

cityLabelText · string

countryLabelText · string

firstNameLabelText · string

lastNameLabelText · string

phoneLabelText · string

provinceLabelText · string

zipLabelText · string

addressHeaderTitleText · string

changeShippingAddressFlag · boolean

updateEditShippingButtonText · string

cancelEditShippingButtonText · string

pauseSubscriptionText · string

resumeSubscriptionText · string

pauseBadgeText · string

customerPortalSettingJson · string

productFilterConfig · string

discountNoteTitle · string

initialDiscountNoteDescription · string

afterCycleDiscountNoteDescription · string

productRemovedTooltip · string

deliveryPriceText · string

shippingOptionText · string

nextDeliveryDate · string

everyLabelText · string

orderNoteFlag · boolean

orderNoteText · string

useUrlWithCustomerId · boolean

expiredTokenText · string

portalLoginLinkText · string

localeDate · string

productSelectionOption · enum<string>

Available options: ALL_PRODUCTS, PRODUCTS_FROM_ALL_PLANS, PRODUCTS_FROM_CURRENT_PLAN

includeOutOfStockProduct · boolean

customerIdText · string

helloNameText · string

goBackButtonText · string

changeVariantLabelText · string

provinceCodeLabelText · string

countryCodeLabelText · string

pleaseWaitLoaderText · string

openBadgeText · string

cancelSubscriptionMinimumBillingIterationsMessage · string

topHtml · string

bottomHtml · string

updateShipmentBillingDate · boolean

discountCodeText · string

discountCodeApplyButtonText · string

discountCode · boolean

applySellingPlanBasedDiscount · boolean

overrideDaysToRescheduleOrder · boolean

applySubscriptionDiscountForOtp · boolean

applySubscriptionDiscount · boolean

allowSwapWhenContractIsFreeze · boolean

removeDiscountCodeAutomatically · boolean

removeDiscountCodeLabel · string

enableSplitContract · boolean

splitContractMessage · string

splitContractText · string

enableMergeContract · boolean

subscriptionDiscountTypeUnit · enum<string>

Available options: PERCENTAGE, AMOUNT

subscriptionDiscount · number<double>

upSellMessage · string

freezeOrderTillMinCycle · boolean

freezeUpdateSubscriptionMessage · string

subscriptionContractFreezeMessage · string

preventCancellationBeforeDaysMessage · string

offerDiscountOnCancellation · boolean

enableSkipFulFillment · boolean

discountPercentageOnCancellation · string

discountMessageOnCancellation · string

discountRecurringCycleLimitOnCancellation · string

frequencyChangeWarningTitle · string

frequencyChangeWarningDescription · string

discountCouponRemoveText · string

pleaseSelectText · string

shippingAddressNotAvailableText · string

sellingPlanNameText · string

discountCouponNotAppliedText · string

shopPayPaymentUpdateText · string

addOneTimeProduct · boolean

allowOrderNow · boolean

selectProductLabelText · string

purchaseOptionLabelText · string

finishLabelText · string

nextBtnText · string

previousBtnText · string

closeBtnText · string

deleteConfirmationMsgText · string

deleteMsgText · string

yesBtnText · string

noBtnText · string

oneTimePurchaseNoteText · string

clickHereText · string

productAddMessageText · string

choosePurchaseOptionLabelText · string

oneTimePurchaseMessageText · string

contractUpdateMessageText · string

oneTimePurchaseDisplayMessageText · string

addProductFinishedMessageText · string

contractErrorMessageText · string

addToSubscriptionTitleCP · string

oneTimePurchaseTitleCP · string

seeMoreProductBtnText · string

viewAttributeLabelText · string

attributeNameLabelText · string

swapProductLabelText · string

swapProductSearchBarText · string

enableSwapProductFeature · boolean

enableTabletForceView · boolean

swapProductBtnText · string

attributeValue · string

addNewButtonText · string

attributeHeadingText · string

enableViewAttributes · boolean

enableSkipIndividualProduct · boolean

enableEditOrderNotes · boolean

showSellingPlanFrequencies · boolean

totalPricePerDeliveryText · string

fulfilledText · string

dateFormat · string

discountCouponAppliedText · string

subscriptionPausedMessageText · string

subscriptionActivatedMessageText · string

unableToUpdateSubscriptionStatusMessageText · string

selectCancellationReasonLabelText · string

upcomingOrderChangePopupSuccessTitleText · string

upcomingOrderChangePopupSuccessDescriptionText · string

upcomingOrderChangePopupSuccessClosebtnText · string

upcomingOrderChangePopupFailureTitleText · string

upcomingOrderChangePopupFailureDescriptionText · string

upcomingOrderChangePopupFailureClosebtnText · string

variantIdsToFreezeEditRemove · string

preventCancellationBeforeDays · string

preventAddRemoveSwapBeforeDays · string

allowCancellationBeforeDays · string

allowAddRemoveSwapBeforeDays · string

disAllowVariantIdsForOneTimeProductAdd · string

disAllowProductIdsForOneTimeProductAdd · string

disAllowVariantIdsForSubscriptionProductAdd · string

allowProductIdsForSubscriptionProductAdd · string

hideAddSubscriptionProductSection · boolean

allowOnlyOneTimeProductOnAddProductFlag · boolean

requireFieldMessage · string

validNumberRequiredMessage · string

variantLbl · string

priceLbl · string

oneTimePurchaseOnlyText · string

rescheduleText · string

popUpSuccessMessage · string

popUpErrorMessage · string

orderNowText · string

upcomingOrderPlaceNowAlertText · string

upcomingOrderSkipAlertText · string

deliveryFrequencyText · string

editDeliveryInternalText · string

maxCycleText · string

minCycleText · string

selectProductToAdd · string

searchProductBtnText · string

areyousureCommonMessageText · string

areyousureResumeMessageText · string

areyousurePauseMessageText · string

editCommonText · string

viewMoreText · string

variantLblText · string

totalLblText · string

deleteProductTitleText · string

greetingText · string

productLblText · string

hasBeenRemovedText · string

orderTotalText · string

addDiscountCodeText · string

addDiscountCodeAlertText · string

removeDiscountCodeAlertText · string

shopPayLblText · string

paypalLblText · string

unknownPaymentReachoutUsText · string

addToOrderLabelText · string

upcomingTabTitle · string

scheduledTabTitle · string

historyTabTitle · string

noOrderNotAvailableMessage · string

continueText · string

confirmSwapText · string

confirmAddProduct · string

minQtyToAllowDuringAddProduct · integer<int32>

allowSplitContract · boolean

enableSwapProductVariant · boolean

enableEditAttributes · boolean

discountAccordionTitle · string

redeemRewardsTextV2 · string

rewardsTextV2 · string

yourRewardsTextV2 · string

yourAvailableRewardsPointsTextV2 · string

cancellationDateTitleText · string

pauseTillDateTitleText · string

selectedCancellationReasonTitleText · string

selectedPauseReasonTitleText · string

cancellationNoteTitleText · string

pauseNoteTitleText · string

selectSplitMethodLabelText · string

splitWithOrderPlacedSelectOptionText · string

splitWithoutOrderPlacedSelectOptionText · string

contractCancelledBadgeText · string

chooseAnotherPaymentMethodTitleText · string

selectPaymentMethodTitleText · string

changePaymentMessage · string

updatePaymentMethodTitleText · string

enableRedirectMyAccountButton · boolean

reschedulingPolicies · string

enableRedirectToProductPage · boolean

enableAllowOnlyOneDiscountCode · boolean

upcomingTabHeaderHTML · string

schedulesTabHeaderHTML · string

historyTabHeaderHTML · string

allowedProductIdsForOneTimeProductAdd · string

allowToAddProductQuantityMinMaxReached · boolean

allowReschedulingContractTrialPeriod · boolean

allowToEditQuantityIfProductOutOfStock · boolean

displayCountryByLanguage · boolean

allowToEditQuantityInSingleBABProduct · boolean

fromDeliveryDateAddDay · integer<int32>

toDeliveryDateAddDay · integer<int32>

showNextOrderDeliveryDate · boolean

singleBABDeletedProductPlaceholderImage · string

allowToSpecificZipCode · string

allowToSpecificZipCodeForLocalDelivery · string

customJs · string

allowAddOneTimeProductOrderIdPrepaid · boolean

discountMessageOnPause · string

swapMessageOnPause · string

giftMessageOnPause · string

skipMessageOnPause · string

pauseMessageOnPause · string

changeDateMessageOnPause · string

changeAddressMessageOnPause · string

updateFrequencyMessageOnPause · string

skipDaysFromCurrentDate · integer<int32>

skipDaysToCurrentDate · integer<int32>

goBackRedirectLink · string

resumeSub · boolean

allowToSameReasonAgain · boolean

deleteOneTimePurchaseProduct · boolean

billingDateRestrictFromDate · string

billingDateRestrictToDays · integer<int32>

multiCurrencyAvailable · boolean

babProductBadgeTextV2 · string

addAdditionalProductInBAB · boolean

disableRescheduleTimeSelector · boolean

filterDeliveryFrequencyOnCustomerTags · boolean

customerPortalLandingPage · string

pauseAccordionTitle · string

disabledKeyFieldFlag · boolean

discountCarryForward · enum<string>

Available options: NONE, EXISTING_PLAN, PRODUCT_PLAN, PRODUCT_THEN_EXISTING

allowProductTagsForSubscriptionProductAdd · string

disAllowProductTagsForSubscriptionProductAdd · string

allowEditQuantityPrepaidSeparatePlan · boolean

enableUpsellProducts · boolean

maxIterationReachedText · string

nextTierAmountTieredDiscountText · string

nextTierPercentageTieredDiscountText · string

amountTieredDiscountText · string

percentageTieredDiscountText · string

sectionTitleText · string

sectionMinMaxTextV2 · string

sectionedBabBadgeText · string

noDeliveryMethodLabelText · string

selectedProductLabelTextV2 · string

discountAppliedTextV2 · string

minProductsInSubscriptionContract · string

addToSubscriptionDiscriptionTextV2 · string

splitContractConfirmButtonText · string

welcomeText · string

enableProductDescription · boolean

allowToAutoAddProduct · boolean

aiAgentEnabled · boolean

aiAgentTier · string

rescheduleOrderDescription · string

splitWithoutOrderPlacedSelectOptionHelpText · string

splitWithOrderPlacedSelectOptionHelpText · string

splitContractNoteText · string

retryFailedOrderConfirmationTextV2 · string

retryFailedOrderDescriptionTextV2 · string

hideSchedulesTabNewCp · boolean

hideHistoryTabNewCp · boolean

hideAttributeAddition · boolean

resumeSubAfterCancellation · boolean

allowCancelDuringFreeTrial · boolean

hidePaymentMethodEdit · boolean

hideResumeButtonWhenMaxCycleReached · boolean

enableUpdateDeliveryMethod · boolean

shopCustomizationData · object[]

Show child attributes

editQuantityLabelText · string