Skip to main content
GET
/
memberships
/
cp
/
api
/
customer-portal-settings
/
{id}
Get customer portal settings
curl --request GET \
  --url https://www.myshop.com/apps/memberships/cp/api/customer-portal-settings/{id}
{
  "shop": "<string>",
  "orderFrequencyText": "<string>",
  "totalProductsText": "<string>",
  "nextOrderText": "<string>",
  "statusText": "<string>",
  "cancelSubscriptionBtnText": "<string>",
  "noSubscriptionMessage": "<string>",
  "subscriptionNoText": "<string>",
  "updatePaymentMessage": "<string>",
  "cardLastFourDigitText": "<string>",
  "cardExpiryText": "<string>",
  "cardHolderNameText": "<string>",
  "cardTypeText": "<string>",
  "paymentMethodTypeText": "<string>",
  "cancelAccordionTitle": "<string>",
  "paymentDetailAccordionTitle": "<string>",
  "upcomingOrderAccordionTitle": "<string>",
  "paymentInfoText": "<string>",
  "updatePaymentBtnText": "<string>",
  "nextOrderDateLbl": "<string>",
  "statusLbl": "<string>",
  "quantityLbl": "<string>",
  "amountLbl": "<string>",
  "orderNoLbl": "<string>",
  "editFrequencyBtnText": "<string>",
  "cancelFreqBtnText": "<string>",
  "updateFreqBtnText": "<string>",
  "id": 123,
  "pauseResumeSub": true,
  "changeNextOrderDate": true,
  "cancelSub": true,
  "changeOrderFrequency": true,
  "createAdditionalOrder": true,
  "manageSubscriptionButtonText": "<string>",
  "editChangeOrderBtnText": "<string>",
  "cancelChangeOrderBtnText": "<string>",
  "updateChangeOrderBtnText": "<string>",
  "editProductButtonText": "<string>",
  "deleteButtonText": "<string>",
  "updateButtonText": "<string>",
  "cancelButtonText": "<string>",
  "addProductButtonText": "<string>",
  "downgradeMembershipLabel": "<string>",
  "addProductLabelText": "<string>",
  "activeBadgeText": "<string>",
  "closeBadgeText": "<string>",
  "skipOrderButtonText": "<string>",
  "productLabelText": "<string>",
  "seeMoreDetailsText": "<string>",
  "hideDetailsText": "<string>",
  "productInSubscriptionText": "<string>",
  "subTotalLabelText": "<string>",
  "paymentNotificationText": "<string>",
  "editProductFlag": true,
  "deleteProductFlag": true,
  "showShipment": true,
  "addAdditionalProduct": true,
  "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>",
  "address1LabelText": "<string>",
  "address2LabelText": "<string>",
  "companyLabelText": "<string>",
  "cityLabelText": "<string>",
  "countryLabelText": "<string>",
  "firstNameLabelText": "<string>",
  "lastNameLabelText": "<string>",
  "phoneLabelText": "<string>",
  "provinceLabelText": "<string>",
  "zipLabelText": "<string>",
  "addressHeaderTitleText": "<string>",
  "changeShippingAddressFlag": true,
  "updateEditShippingButtonText": "<string>",
  "cancelEditShippingButtonText": "<string>",
  "pauseSubscriptionText": "<string>",
  "resumeSubscriptionText": "<string>",
  "pauseBadgeText": "<string>",
  "customerPortalSettingJson": "<string>",
  "discountNoteTitle": "<string>",
  "initialDiscountNoteDescription": "<string>",
  "afterCycleDiscountNoteDescription": "<string>",
  "productRemovedTooltip": "<string>",
  "deliveryPriceText": "<string>",
  "shippingOptionText": "<string>",
  "nextDeliveryDate": "<string>",
  "everyLabelText": "<string>",
  "orderNoteFlag": true,
  "orderNoteText": "<string>",
  "useUrlWithCustomerId": true,
  "expiredTokenText": "<string>",
  "portalLoginLinkText": "<string>",
  "localeDate": "<string>",
  "includeOutOfStockProduct": true,
  "customerIdText": "<string>",
  "helloNameText": "<string>",
  "goBackButtonText": "<string>",
  "changeVariantLabelText": "<string>",
  "provinceCodeLabelText": "<string>",
  "countryCodeLabelText": "<string>",
  "pleaseWaitLoaderText": "<string>",
  "openBadgeText": "<string>",
  "cancelSubscriptionMinimumBillingIterationsMessage": "<string>",
  "topHtml": "<string>",
  "bottomHtml": "<string>",
  "updateShipmentBillingDate": true,
  "discountCodeText": "<string>",
  "discountCodeApplyButtonText": "<string>",
  "discountCode": true,
  "applySubscriptionDiscount": true,
  "subscriptionDiscount": 123,
  "upSellMessage": "<string>",
  "freezeOrderTillMinCycle": true,
  "freezeUpdateSubscriptionMessage": "<string>",
  "addOneTimeProduct": true,
  "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>",
  "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>",
  "viewAttributeLabelText": "<string>",
  "attributeNameLabelText": "<string>",
  "attributeValue": "<string>",
  "addNewButtonText": "<string>",
  "attributeHeadingText": "<string>",
  "enableViewAttributes": true,
  "addProductOnlyForSameProductVariant": true,
  "enableMembershipHistory": true,
  "enableShowProductDescription": true,
  "descriptionLength": "<string>",
  "historyLabelText": "<string>",
  "orderNoLabelText": "<string>",
  "orderDateLabelText": "<string>",
  "lastAttemptDateLabelText": "<string>",
  "membershipExpireText": "<string>",
  "membershipExpireDescription": "<string>",
  "discountRecurringCycleLimitOnCancellation": 123,
  "discountMessageOnCancellation": "<string>",
  "conformationPopupForCancellationDiscountText": "<string>",
  "enableResendMagicLink": true,
  "redeemRewardsText": "<string>",
  "rewardsText": "<string>",
  "yourRewardsText": "<string>",
  "yourAvailableRewardsPointsText": "<string>",
  "productReplaceWarningText": "<string>",
  "additionalFeedbackLabel": "<string>",
  "backToAccountLabel": "<string>",
  "missedBillingAlertText": "<string>",
  "acceptBtnText": "<string>",
  "cancelledOnLabelText": "<string>",
  "cancellationReasonLabelText": "<string>",
  "cancellationFeedbackLabelText": "<string>",
  "preventCancellationBeforeDaysMessage": "<string>",
  "retrieveMagicLinkDescription": "<string>",
  "retrieveMagicLinkText": "<string>",
  "lastBillingAttemptFailedText": "<string>",
  "preventCancellationBeforeDays": "<string>",
  "allowCancellationBeforeDays": "<string>",
  "enableRedirectMyAccountButton": true,
  "goBackRedirectLink": "<string>",
  "resumeSub": true,
  "deliveryFrequencyLabelText": "<string>",
  "deliverLabelText": "<string>",
  "daysLabelText": "<string>",
  "weeksLabelText": "<string>",
  "monthsLabelText": "<string>",
  "yearsLabelText": "<string>",
  "removedTagOnFreeTrial": "<string>",
  "chooseAnotherPaymentMethodText": "<string>",
  "editShippingModalLabel": "<string>",
  "continueButtonLabel": "<string>",
  "selectDeliveryMethodLabel": "<string>",
  "saveButtonLabel": "<string>",
  "showUpcomingOrdersLabel": "<string>",
  "shippingAddressLabel": "<string>",
  "shippingMethodLabel": "<string>",
  "subtotalLabel": "<string>",
  "resumeMembershipLabel": "<string>",
  "closeButtonLabel": "<string>",
  "pauseMembershipLabel": "<string>",
  "pauseMembershipMessageText": "<string>",
  "noPaymentMethodFoundText": "<string>",
  "membershipPerksDetailsText": "<string>",
  "resumeSubscriptionDescriptionText": "<string>",
  "skipFirstPage": true,
  "welcomeText": "<string>",
  "removeButtonText": "<string>",
  "productConfirmationButtonLabel": "<string>",
  "cancelPendingDowngradeBtnText": "<string>",
  "cancelPendingDowngradeText": "<string>",
  "currentMembershipPlanText": "<string>",
  "successStatusText": "<string>",
  "failureStatusText": "<string>",
  "newPlanText": "<string>",
  "currentMembershipText": "<string>",
  "upgradeBadgeText": "<string>",
  "downgradeBadgeText": "<string>",
  "loadingProductsText": "<string>",
  "noProductsAvailableText": "<string>",
  "loadMoreProductsText": "<string>",
  "errorText": "<string>",
  "selectNewPlanText": "<string>",
  "sendEmailTextV2": "<string>",
  "samePriceText": "<string>",
  "translationUpdateRequest": {
    "id": 123,
    "value": "<string>"
  },
  "manageBtnText": "<string>",
  "scheduleUpgradeText": "<string>",
  "scheduleDowngradeText": "<string>",
  "pendingDowngradeTitleText": "<string>",
  "cancelPendingUpgradeText": "<string>",
  "cancelPendingUpgradeBtnText": "<string>",
  "cancellationSecurityModalTitle": "<string>",
  "cancellationSecurityModalMessage": "<string>",
  "editQuantityLabelText": "<string>"
}

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.

Path Parameters

id
string
required

Response

200 - */*

OK

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
downgradeMembershipLabel
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
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
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
discountNoteTitle
string
initialDiscountNoteDescription
string
afterCycleDiscountNoteDescription
string
productRemovedTooltip
string
deliveryPriceText
string
shippingOptionText
string
nextDeliveryDate
string
everyLabelText
string
orderNoteFlag
boolean
orderNoteText
string
useUrlWithCustomerId
boolean
expiredTokenText
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
applySubscriptionDiscount
boolean
subscriptionDiscountTypeUnit
enum<string>
Available options:
PERCENTAGE,
AMOUNT
subscriptionDiscount
number<double>
upSellMessage
string
freezeOrderTillMinCycle
boolean
freezeUpdateSubscriptionMessage
string
addOneTimeProduct
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
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
viewAttributeLabelText
string
attributeNameLabelText
string
attributeValue
string
addNewButtonText
string
attributeHeadingText
string
enableViewAttributes
boolean
addProductOnlyForSameProductVariant
boolean
enableMembershipHistory
boolean
enableShowProductDescription
boolean
descriptionLength
string
historyLabelText
string
orderNoLabelText
string
orderDateLabelText
string
lastAttemptDateLabelText
string
membershipExpireText
string
membershipExpireDescription
string
discountRecurringCycleLimitOnCancellation
integer<int32>
discountMessageOnCancellation
string
conformationPopupForCancellationDiscountText
string
redeemRewardsText
string
rewardsText
string
yourRewardsText
string
yourAvailableRewardsPointsText
string
productReplaceWarningText
string
additionalFeedbackLabel
string
backToAccountLabel
string
missedBillingAlertText
string
acceptBtnText
string
cancelledOnLabelText
string
cancellationReasonLabelText
string
cancellationFeedbackLabelText
string
preventCancellationBeforeDaysMessage
string
membershipSwap
enum<string>
Available options:
UPGRADE_ONLY,
DOWNGRADE_ONLY,
UPGRADE_AND_DOWNGRADE,
NONE
lastBillingAttemptFailedText
string
preventCancellationBeforeDays
string
allowCancellationBeforeDays
string
enableRedirectMyAccountButton
boolean
resumeSub
boolean
deliveryFrequencyLabelText
string
deliverLabelText
string
daysLabelText
string
weeksLabelText
string
monthsLabelText
string
yearsLabelText
string
removedTagOnFreeTrial
string
chooseAnotherPaymentMethodText
string
editShippingModalLabel
string
continueButtonLabel
string
selectDeliveryMethodLabel
string
saveButtonLabel
string
showUpcomingOrdersLabel
string
shippingAddressLabel
string
shippingMethodLabel
string
subtotalLabel
string
resumeMembershipLabel
string
closeButtonLabel
string
pauseMembershipLabel
string
pauseMembershipMessageText
string
noPaymentMethodFoundText
string
membershipPerksDetailsText
string
resumeSubscriptionDescriptionText
string
skipFirstPage
boolean
welcomeText
string
removeButtonText
string
productConfirmationButtonLabel
string
cancelPendingDowngradeBtnText
string
cancelPendingDowngradeText
string
currentMembershipPlanText
string
successStatusText
string
failureStatusText
string
newPlanText
string
currentMembershipText
string
upgradeBadgeText
string
downgradeBadgeText
string
loadingProductsText
string
noProductsAvailableText
string
loadMoreProductsText
string
errorText
string
selectNewPlanText
string
sendEmailTextV2
string
samePriceText
string
translationUpdateRequest
object
manageBtnText
string
scheduleUpgradeText
string
scheduleDowngradeText
string
pendingDowngradeTitleText
string
cancelPendingUpgradeText
string
cancelPendingUpgradeBtnText
string
cancellationSecurityModalTitle
string
cancellationSecurityModalMessage
string
editQuantityLabelText
string