Skip to main content
GET
/
api
/
external
/
v2
/
customer-portal-settings
/
{id}
Get customer portal settings
curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}
import requests

url = "https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}';
const options = {method: 'GET'};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "amountLbl": "<string>",
  "cancelAccordionTitle": "<string>",
  "cancelFreqBtnText": "<string>",
  "cancelSubscriptionBtnText": "<string>",
  "cardExpiryText": "<string>",
  "cardHolderNameText": "<string>",
  "cardLastFourDigitText": "<string>",
  "cardTypeText": "<string>",
  "editFrequencyBtnText": "<string>",
  "nextOrderDateLbl": "<string>",
  "nextOrderText": "<string>",
  "noSubscriptionMessage": "<string>",
  "orderFrequencyText": "<string>",
  "orderNoLbl": "<string>",
  "paymentDetailAccordionTitle": "<string>",
  "paymentInfoText": "<string>",
  "paymentMethodTypeText": "<string>",
  "quantityLbl": "<string>",
  "shop": "<string>",
  "statusLbl": "<string>",
  "statusText": "<string>",
  "subscriptionNoText": "<string>",
  "totalProductsText": "<string>",
  "upcomingOrderAccordionTitle": "<string>",
  "updateFreqBtnText": "<string>",
  "updatePaymentBtnText": "<string>",
  "updatePaymentMessage": "<string>",
  "acceptBtnText": "<string>",
  "activeBadgeText": "<string>",
  "addAdditionalProduct": true,
  "addNewButtonText": "<string>",
  "addOneTimeProduct": true,
  "addProductButtonText": "<string>",
  "addProductFinishedMessageText": "<string>",
  "addProductLabelText": "<string>",
  "addProductOnlyForSameProductVariant": true,
  "addToSubscriptionTitleCP": "<string>",
  "additionalFeedbackLabel": "<string>",
  "address1LabelText": "<string>",
  "address2LabelText": "<string>",
  "addressHeaderTitleText": "<string>",
  "afterCycleDiscountNoteDescription": "<string>",
  "allowCancellationBeforeDays": "<string>",
  "applySubscriptionDiscount": true,
  "attributeHeadingText": "<string>",
  "attributeNameLabelText": "<string>",
  "attributeValue": "<string>",
  "backToAccountLabel": "<string>",
  "bottomHtml": "<string>",
  "cancelButtonText": "<string>",
  "cancelChangeOrderBtnText": "<string>",
  "cancelEditShippingButtonText": "<string>",
  "cancelPendingDowngradeBtnText": "<string>",
  "cancelPendingDowngradeText": "<string>",
  "cancelPendingUpgradeBtnText": "<string>",
  "cancelPendingUpgradeText": "<string>",
  "cancelSub": true,
  "cancelSubscriptionConfirmPayAsYouGoText": "<string>",
  "cancelSubscriptionConfirmPrepaidText": "<string>",
  "cancelSubscriptionMinimumBillingIterationsMessage": "<string>",
  "cancelSubscriptionPayAsYouGoButtonText": "<string>",
  "cancelSubscriptionPrepaidButtonText": "<string>",
  "cancellationFeedbackLabelText": "<string>",
  "cancellationReasonLabelText": "<string>",
  "cancellationSecurityModalMessage": "<string>",
  "cancellationSecurityModalTitle": "<string>",
  "cancelledOnLabelText": "<string>",
  "changeNextOrderDate": true,
  "changeOrderFrequency": true,
  "changeShippingAddressFlag": true,
  "changeVariantLabelText": "<string>",
  "chooseAnotherPaymentMethodText": "<string>",
  "choosePurchaseOptionLabelText": "<string>",
  "cityLabelText": "<string>",
  "clickHereText": "<string>",
  "closeBadgeText": "<string>",
  "closeBtnText": "<string>",
  "closeButtonLabel": "<string>",
  "companyLabelText": "<string>",
  "conformationPopupForCancellationDiscountText": "<string>",
  "continueButtonLabel": "<string>",
  "contractErrorMessageText": "<string>",
  "contractUpdateMessageText": "<string>",
  "countryCodeLabelText": "<string>",
  "countryLabelText": "<string>",
  "createAdditionalOrder": true,
  "creditCardText": "<string>",
  "currentMembershipPlanText": "<string>",
  "currentMembershipText": "<string>",
  "customerIdText": "<string>",
  "customerPortalSettingJson": "<string>",
  "dateFormat": "<string>",
  "dayText": "<string>",
  "daysLabelText": "<string>",
  "deleteButtonText": "<string>",
  "deleteConfirmationMsgText": "<string>",
  "deleteMsgText": "<string>",
  "deleteProductFlag": true,
  "deliverLabelText": "<string>",
  "deliveryFrequencyLabelText": "<string>",
  "deliveryPriceText": "<string>",
  "descriptionLength": "<string>",
  "discountCode": true,
  "discountCodeApplyButtonText": "<string>",
  "discountCodeText": "<string>",
  "discountCouponAppliedText": "<string>",
  "discountMessageOnCancellation": "<string>",
  "discountNoteTitle": "<string>",
  "discountRecurringCycleLimitOnCancellation": 123,
  "downgradeBadgeText": "<string>",
  "downgradeMembershipLabel": "<string>",
  "editChangeOrderBtnText": "<string>",
  "editProductButtonText": "<string>",
  "editProductFlag": true,
  "editQuantityLabelText": "<string>",
  "editShippingModalLabel": "<string>",
  "enableMembershipHistory": true,
  "enableRedirectMyAccountButton": true,
  "enableResendMagicLink": true,
  "enableShowProductDescription": true,
  "enableViewAttributes": true,
  "endingWithText": "<string>",
  "errorText": "<string>",
  "everyLabelText": "<string>",
  "expiredTokenText": "<string>",
  "failureStatusText": "<string>",
  "finishLabelText": "<string>",
  "firstNameLabelText": "<string>",
  "freezeOrderTillMinCycle": true,
  "freezeUpdateSubscriptionMessage": "<string>",
  "fulfilledText": "<string>",
  "goBackButtonText": "<string>",
  "goBackRedirectLink": "<string>",
  "helloNameText": "<string>",
  "hideDetailsText": "<string>",
  "historyLabelText": "<string>",
  "id": 123,
  "includeOutOfStockProduct": true,
  "initialDiscountNoteDescription": "<string>",
  "lastAttemptDateLabelText": "<string>",
  "lastBillingAttemptFailedText": "<string>",
  "lastNameLabelText": "<string>",
  "loadMoreProductsText": "<string>",
  "loadingProductsText": "<string>",
  "localeDate": "<string>",
  "manageBtnText": "<string>",
  "manageSubscriptionButtonText": "<string>",
  "membershipExpireDescription": "<string>",
  "membershipExpireText": "<string>",
  "membershipPerksDetailsText": "<string>",
  "missedBillingAlertText": "<string>",
  "monthText": "<string>",
  "monthsLabelText": "<string>",
  "newPlanText": "<string>",
  "nextBtnText": "<string>",
  "nextDeliveryDate": "<string>",
  "noBtnText": "<string>",
  "noPaymentMethodFoundText": "<string>",
  "noProductsAvailableText": "<string>",
  "oneTimePurchaseDisplayMessageText": "<string>",
  "oneTimePurchaseMessageText": "<string>",
  "oneTimePurchaseNoteText": "<string>",
  "oneTimePurchaseTitleCP": "<string>",
  "openBadgeText": "<string>",
  "orderDateLabelText": "<string>",
  "orderNoLabelText": "<string>",
  "orderNoteFlag": true,
  "orderNoteText": "<string>",
  "pauseBadgeText": "<string>",
  "pauseMembershipLabel": "<string>",
  "pauseMembershipMessageText": "<string>",
  "pauseResumeSub": true,
  "pauseSubscriptionText": "<string>",
  "paymentNotificationText": "<string>",
  "pendingDowngradeTitleText": "<string>",
  "phoneLabelText": "<string>",
  "pleaseWaitLoaderText": "<string>",
  "portalLoginLinkText": "<string>",
  "preventCancellationBeforeDays": "<string>",
  "preventCancellationBeforeDaysMessage": "<string>",
  "previousBtnText": "<string>",
  "productAddMessageText": "<string>",
  "productConfirmationButtonLabel": "<string>",
  "productInSubscriptionText": "<string>",
  "productLabelText": "<string>",
  "productRemovedTooltip": "<string>",
  "productReplaceWarningText": "<string>",
  "provinceCodeLabelText": "<string>",
  "provinceLabelText": "<string>",
  "purchaseOptionLabelText": "<string>",
  "queueBadgeText": "<string>",
  "redeemRewardsText": "<string>",
  "removeButtonText": "<string>",
  "removedTagOnFreeTrial": "<string>",
  "resumeMembershipLabel": "<string>",
  "resumeSub": true,
  "resumeSubscriptionDescriptionText": "<string>",
  "resumeSubscriptionText": "<string>",
  "retrieveMagicLinkDescription": "<string>",
  "retrieveMagicLinkText": "<string>",
  "rewardsText": "<string>",
  "samePriceText": "<string>",
  "saveButtonLabel": "<string>",
  "scheduleDowngradeText": "<string>",
  "scheduleUpgradeText": "<string>",
  "seeMoreDetailsText": "<string>",
  "seeMoreProductBtnText": "<string>",
  "selectCancellationReasonLabelText": "<string>",
  "selectDeliveryMethodLabel": "<string>",
  "selectNewPlanText": "<string>",
  "selectProductLabelText": "<string>",
  "sendEmailTextV2": "<string>",
  "shippingAddressLabel": "<string>",
  "shippingLabelText": "<string>",
  "shippingMethodLabel": "<string>",
  "shippingOptionText": "<string>",
  "showShipment": true,
  "showUpcomingOrdersLabel": "<string>",
  "skipBadgeText": "<string>",
  "skipFirstPage": true,
  "skipOrderButtonText": "<string>",
  "subTotalLabelText": "<string>",
  "subscriptionActivatedMessageText": "<string>",
  "subscriptionDiscount": 123,
  "subscriptionPausedMessageText": "<string>",
  "subtotalLabel": "<string>",
  "successStatusText": "<string>",
  "successText": "<string>",
  "topHtml": "<string>",
  "totalPricePerDeliveryText": "<string>",
  "translationUpdateRequest": {
    "id": 123,
    "value": "<string>"
  },
  "unableToUpdateSubscriptionStatusMessageText": "<string>",
  "upSellMessage": "<string>",
  "upcomingFulfillmentText": "<string>",
  "upcomingOrderChangePopupFailureClosebtnText": "<string>",
  "upcomingOrderChangePopupFailureDescriptionText": "<string>",
  "upcomingOrderChangePopupFailureTitleText": "<string>",
  "upcomingOrderChangePopupSuccessClosebtnText": "<string>",
  "upcomingOrderChangePopupSuccessDescriptionText": "<string>",
  "upcomingOrderChangePopupSuccessTitleText": "<string>",
  "updateButtonText": "<string>",
  "updateChangeOrderBtnText": "<string>",
  "updateEditShippingButtonText": "<string>",
  "updateShipmentBillingDate": true,
  "upgradeBadgeText": "<string>",
  "useUrlWithCustomerId": true,
  "viewAttributeLabelText": "<string>",
  "weekText": "<string>",
  "weeksLabelText": "<string>",
  "welcomeText": "<string>",
  "yearText": "<string>",
  "yearsLabelText": "<string>",
  "yesBtnText": "<string>",
  "yourAvailableRewardsPointsText": "<string>",
  "yourRewardsText": "<string>",
  "zipLabelText": "<string>"
}
{
"amountLbl": "<string>",
"cancelAccordionTitle": "<string>",
"cancelFreqBtnText": "<string>",
"cancelSubscriptionBtnText": "<string>",
"cardExpiryText": "<string>",
"cardHolderNameText": "<string>",
"cardLastFourDigitText": "<string>",
"cardTypeText": "<string>",
"editFrequencyBtnText": "<string>",
"nextOrderDateLbl": "<string>",
"nextOrderText": "<string>",
"noSubscriptionMessage": "<string>",
"orderFrequencyText": "<string>",
"orderNoLbl": "<string>",
"paymentDetailAccordionTitle": "<string>",
"paymentInfoText": "<string>",
"paymentMethodTypeText": "<string>",
"quantityLbl": "<string>",
"shop": "<string>",
"statusLbl": "<string>",
"statusText": "<string>",
"subscriptionNoText": "<string>",
"totalProductsText": "<string>",
"upcomingOrderAccordionTitle": "<string>",
"updateFreqBtnText": "<string>",
"updatePaymentBtnText": "<string>",
"updatePaymentMessage": "<string>",
"acceptBtnText": "<string>",
"activeBadgeText": "<string>",
"addAdditionalProduct": true,
"addNewButtonText": "<string>",
"addOneTimeProduct": true,
"addProductButtonText": "<string>",
"addProductFinishedMessageText": "<string>",
"addProductLabelText": "<string>",
"addProductOnlyForSameProductVariant": true,
"addToSubscriptionTitleCP": "<string>",
"additionalFeedbackLabel": "<string>",
"address1LabelText": "<string>",
"address2LabelText": "<string>",
"addressHeaderTitleText": "<string>",
"afterCycleDiscountNoteDescription": "<string>",
"allowCancellationBeforeDays": "<string>",
"applySubscriptionDiscount": true,
"attributeHeadingText": "<string>",
"attributeNameLabelText": "<string>",
"attributeValue": "<string>",
"backToAccountLabel": "<string>",
"bottomHtml": "<string>",
"cancelButtonText": "<string>",
"cancelChangeOrderBtnText": "<string>",
"cancelEditShippingButtonText": "<string>",
"cancelPendingDowngradeBtnText": "<string>",
"cancelPendingDowngradeText": "<string>",
"cancelPendingUpgradeBtnText": "<string>",
"cancelPendingUpgradeText": "<string>",
"cancelSub": true,
"cancelSubscriptionConfirmPayAsYouGoText": "<string>",
"cancelSubscriptionConfirmPrepaidText": "<string>",
"cancelSubscriptionMinimumBillingIterationsMessage": "<string>",
"cancelSubscriptionPayAsYouGoButtonText": "<string>",
"cancelSubscriptionPrepaidButtonText": "<string>",
"cancellationFeedbackLabelText": "<string>",
"cancellationReasonLabelText": "<string>",
"cancellationSecurityModalMessage": "<string>",
"cancellationSecurityModalTitle": "<string>",
"cancelledOnLabelText": "<string>",
"changeNextOrderDate": true,
"changeOrderFrequency": true,
"changeShippingAddressFlag": true,
"changeVariantLabelText": "<string>",
"chooseAnotherPaymentMethodText": "<string>",
"choosePurchaseOptionLabelText": "<string>",
"cityLabelText": "<string>",
"clickHereText": "<string>",
"closeBadgeText": "<string>",
"closeBtnText": "<string>",
"closeButtonLabel": "<string>",
"companyLabelText": "<string>",
"conformationPopupForCancellationDiscountText": "<string>",
"continueButtonLabel": "<string>",
"contractErrorMessageText": "<string>",
"contractUpdateMessageText": "<string>",
"countryCodeLabelText": "<string>",
"countryLabelText": "<string>",
"createAdditionalOrder": true,
"creditCardText": "<string>",
"currentMembershipPlanText": "<string>",
"currentMembershipText": "<string>",
"customerIdText": "<string>",
"customerPortalSettingJson": "<string>",
"dateFormat": "<string>",
"dayText": "<string>",
"daysLabelText": "<string>",
"deleteButtonText": "<string>",
"deleteConfirmationMsgText": "<string>",
"deleteMsgText": "<string>",
"deleteProductFlag": true,
"deliverLabelText": "<string>",
"deliveryFrequencyLabelText": "<string>",
"deliveryPriceText": "<string>",
"descriptionLength": "<string>",
"discountCode": true,
"discountCodeApplyButtonText": "<string>",
"discountCodeText": "<string>",
"discountCouponAppliedText": "<string>",
"discountMessageOnCancellation": "<string>",
"discountNoteTitle": "<string>",
"discountRecurringCycleLimitOnCancellation": 123,
"downgradeBadgeText": "<string>",
"downgradeMembershipLabel": "<string>",
"editChangeOrderBtnText": "<string>",
"editProductButtonText": "<string>",
"editProductFlag": true,
"editQuantityLabelText": "<string>",
"editShippingModalLabel": "<string>",
"enableMembershipHistory": true,
"enableRedirectMyAccountButton": true,
"enableResendMagicLink": true,
"enableShowProductDescription": true,
"enableViewAttributes": true,
"endingWithText": "<string>",
"errorText": "<string>",
"everyLabelText": "<string>",
"expiredTokenText": "<string>",
"failureStatusText": "<string>",
"finishLabelText": "<string>",
"firstNameLabelText": "<string>",
"freezeOrderTillMinCycle": true,
"freezeUpdateSubscriptionMessage": "<string>",
"fulfilledText": "<string>",
"goBackButtonText": "<string>",
"goBackRedirectLink": "<string>",
"helloNameText": "<string>",
"hideDetailsText": "<string>",
"historyLabelText": "<string>",
"id": 123,
"includeOutOfStockProduct": true,
"initialDiscountNoteDescription": "<string>",
"lastAttemptDateLabelText": "<string>",
"lastBillingAttemptFailedText": "<string>",
"lastNameLabelText": "<string>",
"loadMoreProductsText": "<string>",
"loadingProductsText": "<string>",
"localeDate": "<string>",
"manageBtnText": "<string>",
"manageSubscriptionButtonText": "<string>",
"membershipExpireDescription": "<string>",
"membershipExpireText": "<string>",
"membershipPerksDetailsText": "<string>",
"missedBillingAlertText": "<string>",
"monthText": "<string>",
"monthsLabelText": "<string>",
"newPlanText": "<string>",
"nextBtnText": "<string>",
"nextDeliveryDate": "<string>",
"noBtnText": "<string>",
"noPaymentMethodFoundText": "<string>",
"noProductsAvailableText": "<string>",
"oneTimePurchaseDisplayMessageText": "<string>",
"oneTimePurchaseMessageText": "<string>",
"oneTimePurchaseNoteText": "<string>",
"oneTimePurchaseTitleCP": "<string>",
"openBadgeText": "<string>",
"orderDateLabelText": "<string>",
"orderNoLabelText": "<string>",
"orderNoteFlag": true,
"orderNoteText": "<string>",
"pauseBadgeText": "<string>",
"pauseMembershipLabel": "<string>",
"pauseMembershipMessageText": "<string>",
"pauseResumeSub": true,
"pauseSubscriptionText": "<string>",
"paymentNotificationText": "<string>",
"pendingDowngradeTitleText": "<string>",
"phoneLabelText": "<string>",
"pleaseWaitLoaderText": "<string>",
"portalLoginLinkText": "<string>",
"preventCancellationBeforeDays": "<string>",
"preventCancellationBeforeDaysMessage": "<string>",
"previousBtnText": "<string>",
"productAddMessageText": "<string>",
"productConfirmationButtonLabel": "<string>",
"productInSubscriptionText": "<string>",
"productLabelText": "<string>",
"productRemovedTooltip": "<string>",
"productReplaceWarningText": "<string>",
"provinceCodeLabelText": "<string>",
"provinceLabelText": "<string>",
"purchaseOptionLabelText": "<string>",
"queueBadgeText": "<string>",
"redeemRewardsText": "<string>",
"removeButtonText": "<string>",
"removedTagOnFreeTrial": "<string>",
"resumeMembershipLabel": "<string>",
"resumeSub": true,
"resumeSubscriptionDescriptionText": "<string>",
"resumeSubscriptionText": "<string>",
"retrieveMagicLinkDescription": "<string>",
"retrieveMagicLinkText": "<string>",
"rewardsText": "<string>",
"samePriceText": "<string>",
"saveButtonLabel": "<string>",
"scheduleDowngradeText": "<string>",
"scheduleUpgradeText": "<string>",
"seeMoreDetailsText": "<string>",
"seeMoreProductBtnText": "<string>",
"selectCancellationReasonLabelText": "<string>",
"selectDeliveryMethodLabel": "<string>",
"selectNewPlanText": "<string>",
"selectProductLabelText": "<string>",
"sendEmailTextV2": "<string>",
"shippingAddressLabel": "<string>",
"shippingLabelText": "<string>",
"shippingMethodLabel": "<string>",
"shippingOptionText": "<string>",
"showShipment": true,
"showUpcomingOrdersLabel": "<string>",
"skipBadgeText": "<string>",
"skipFirstPage": true,
"skipOrderButtonText": "<string>",
"subTotalLabelText": "<string>",
"subscriptionActivatedMessageText": "<string>",
"subscriptionDiscount": 123,
"subscriptionPausedMessageText": "<string>",
"subtotalLabel": "<string>",
"successStatusText": "<string>",
"successText": "<string>",
"topHtml": "<string>",
"totalPricePerDeliveryText": "<string>",
"translationUpdateRequest": {
"id": 123,
"value": "<string>"
},
"unableToUpdateSubscriptionStatusMessageText": "<string>",
"upSellMessage": "<string>",
"upcomingFulfillmentText": "<string>",
"upcomingOrderChangePopupFailureClosebtnText": "<string>",
"upcomingOrderChangePopupFailureDescriptionText": "<string>",
"upcomingOrderChangePopupFailureTitleText": "<string>",
"upcomingOrderChangePopupSuccessClosebtnText": "<string>",
"upcomingOrderChangePopupSuccessDescriptionText": "<string>",
"upcomingOrderChangePopupSuccessTitleText": "<string>",
"updateButtonText": "<string>",
"updateChangeOrderBtnText": "<string>",
"updateEditShippingButtonText": "<string>",
"updateShipmentBillingDate": true,
"upgradeBadgeText": "<string>",
"useUrlWithCustomerId": true,
"viewAttributeLabelText": "<string>",
"weekText": "<string>",
"weeksLabelText": "<string>",
"welcomeText": "<string>",
"yearText": "<string>",
"yearsLabelText": "<string>",
"yesBtnText": "<string>",
"yourAvailableRewardsPointsText": "<string>",
"yourRewardsText": "<string>",
"zipLabelText": "<string>"
}
{
"amountLbl": "<string>",
"cancelAccordionTitle": "<string>",
"cancelFreqBtnText": "<string>",
"cancelSubscriptionBtnText": "<string>",
"cardExpiryText": "<string>",
"cardHolderNameText": "<string>",
"cardLastFourDigitText": "<string>",
"cardTypeText": "<string>",
"editFrequencyBtnText": "<string>",
"nextOrderDateLbl": "<string>",
"nextOrderText": "<string>",
"noSubscriptionMessage": "<string>",
"orderFrequencyText": "<string>",
"orderNoLbl": "<string>",
"paymentDetailAccordionTitle": "<string>",
"paymentInfoText": "<string>",
"paymentMethodTypeText": "<string>",
"quantityLbl": "<string>",
"shop": "<string>",
"statusLbl": "<string>",
"statusText": "<string>",
"subscriptionNoText": "<string>",
"totalProductsText": "<string>",
"upcomingOrderAccordionTitle": "<string>",
"updateFreqBtnText": "<string>",
"updatePaymentBtnText": "<string>",
"updatePaymentMessage": "<string>",
"acceptBtnText": "<string>",
"activeBadgeText": "<string>",
"addAdditionalProduct": true,
"addNewButtonText": "<string>",
"addOneTimeProduct": true,
"addProductButtonText": "<string>",
"addProductFinishedMessageText": "<string>",
"addProductLabelText": "<string>",
"addProductOnlyForSameProductVariant": true,
"addToSubscriptionTitleCP": "<string>",
"additionalFeedbackLabel": "<string>",
"address1LabelText": "<string>",
"address2LabelText": "<string>",
"addressHeaderTitleText": "<string>",
"afterCycleDiscountNoteDescription": "<string>",
"allowCancellationBeforeDays": "<string>",
"applySubscriptionDiscount": true,
"attributeHeadingText": "<string>",
"attributeNameLabelText": "<string>",
"attributeValue": "<string>",
"backToAccountLabel": "<string>",
"bottomHtml": "<string>",
"cancelButtonText": "<string>",
"cancelChangeOrderBtnText": "<string>",
"cancelEditShippingButtonText": "<string>",
"cancelPendingDowngradeBtnText": "<string>",
"cancelPendingDowngradeText": "<string>",
"cancelPendingUpgradeBtnText": "<string>",
"cancelPendingUpgradeText": "<string>",
"cancelSub": true,
"cancelSubscriptionConfirmPayAsYouGoText": "<string>",
"cancelSubscriptionConfirmPrepaidText": "<string>",
"cancelSubscriptionMinimumBillingIterationsMessage": "<string>",
"cancelSubscriptionPayAsYouGoButtonText": "<string>",
"cancelSubscriptionPrepaidButtonText": "<string>",
"cancellationFeedbackLabelText": "<string>",
"cancellationReasonLabelText": "<string>",
"cancellationSecurityModalMessage": "<string>",
"cancellationSecurityModalTitle": "<string>",
"cancelledOnLabelText": "<string>",
"changeNextOrderDate": true,
"changeOrderFrequency": true,
"changeShippingAddressFlag": true,
"changeVariantLabelText": "<string>",
"chooseAnotherPaymentMethodText": "<string>",
"choosePurchaseOptionLabelText": "<string>",
"cityLabelText": "<string>",
"clickHereText": "<string>",
"closeBadgeText": "<string>",
"closeBtnText": "<string>",
"closeButtonLabel": "<string>",
"companyLabelText": "<string>",
"conformationPopupForCancellationDiscountText": "<string>",
"continueButtonLabel": "<string>",
"contractErrorMessageText": "<string>",
"contractUpdateMessageText": "<string>",
"countryCodeLabelText": "<string>",
"countryLabelText": "<string>",
"createAdditionalOrder": true,
"creditCardText": "<string>",
"currentMembershipPlanText": "<string>",
"currentMembershipText": "<string>",
"customerIdText": "<string>",
"customerPortalSettingJson": "<string>",
"dateFormat": "<string>",
"dayText": "<string>",
"daysLabelText": "<string>",
"deleteButtonText": "<string>",
"deleteConfirmationMsgText": "<string>",
"deleteMsgText": "<string>",
"deleteProductFlag": true,
"deliverLabelText": "<string>",
"deliveryFrequencyLabelText": "<string>",
"deliveryPriceText": "<string>",
"descriptionLength": "<string>",
"discountCode": true,
"discountCodeApplyButtonText": "<string>",
"discountCodeText": "<string>",
"discountCouponAppliedText": "<string>",
"discountMessageOnCancellation": "<string>",
"discountNoteTitle": "<string>",
"discountRecurringCycleLimitOnCancellation": 123,
"downgradeBadgeText": "<string>",
"downgradeMembershipLabel": "<string>",
"editChangeOrderBtnText": "<string>",
"editProductButtonText": "<string>",
"editProductFlag": true,
"editQuantityLabelText": "<string>",
"editShippingModalLabel": "<string>",
"enableMembershipHistory": true,
"enableRedirectMyAccountButton": true,
"enableResendMagicLink": true,
"enableShowProductDescription": true,
"enableViewAttributes": true,
"endingWithText": "<string>",
"errorText": "<string>",
"everyLabelText": "<string>",
"expiredTokenText": "<string>",
"failureStatusText": "<string>",
"finishLabelText": "<string>",
"firstNameLabelText": "<string>",
"freezeOrderTillMinCycle": true,
"freezeUpdateSubscriptionMessage": "<string>",
"fulfilledText": "<string>",
"goBackButtonText": "<string>",
"goBackRedirectLink": "<string>",
"helloNameText": "<string>",
"hideDetailsText": "<string>",
"historyLabelText": "<string>",
"id": 123,
"includeOutOfStockProduct": true,
"initialDiscountNoteDescription": "<string>",
"lastAttemptDateLabelText": "<string>",
"lastBillingAttemptFailedText": "<string>",
"lastNameLabelText": "<string>",
"loadMoreProductsText": "<string>",
"loadingProductsText": "<string>",
"localeDate": "<string>",
"manageBtnText": "<string>",
"manageSubscriptionButtonText": "<string>",
"membershipExpireDescription": "<string>",
"membershipExpireText": "<string>",
"membershipPerksDetailsText": "<string>",
"missedBillingAlertText": "<string>",
"monthText": "<string>",
"monthsLabelText": "<string>",
"newPlanText": "<string>",
"nextBtnText": "<string>",
"nextDeliveryDate": "<string>",
"noBtnText": "<string>",
"noPaymentMethodFoundText": "<string>",
"noProductsAvailableText": "<string>",
"oneTimePurchaseDisplayMessageText": "<string>",
"oneTimePurchaseMessageText": "<string>",
"oneTimePurchaseNoteText": "<string>",
"oneTimePurchaseTitleCP": "<string>",
"openBadgeText": "<string>",
"orderDateLabelText": "<string>",
"orderNoLabelText": "<string>",
"orderNoteFlag": true,
"orderNoteText": "<string>",
"pauseBadgeText": "<string>",
"pauseMembershipLabel": "<string>",
"pauseMembershipMessageText": "<string>",
"pauseResumeSub": true,
"pauseSubscriptionText": "<string>",
"paymentNotificationText": "<string>",
"pendingDowngradeTitleText": "<string>",
"phoneLabelText": "<string>",
"pleaseWaitLoaderText": "<string>",
"portalLoginLinkText": "<string>",
"preventCancellationBeforeDays": "<string>",
"preventCancellationBeforeDaysMessage": "<string>",
"previousBtnText": "<string>",
"productAddMessageText": "<string>",
"productConfirmationButtonLabel": "<string>",
"productInSubscriptionText": "<string>",
"productLabelText": "<string>",
"productRemovedTooltip": "<string>",
"productReplaceWarningText": "<string>",
"provinceCodeLabelText": "<string>",
"provinceLabelText": "<string>",
"purchaseOptionLabelText": "<string>",
"queueBadgeText": "<string>",
"redeemRewardsText": "<string>",
"removeButtonText": "<string>",
"removedTagOnFreeTrial": "<string>",
"resumeMembershipLabel": "<string>",
"resumeSub": true,
"resumeSubscriptionDescriptionText": "<string>",
"resumeSubscriptionText": "<string>",
"retrieveMagicLinkDescription": "<string>",
"retrieveMagicLinkText": "<string>",
"rewardsText": "<string>",
"samePriceText": "<string>",
"saveButtonLabel": "<string>",
"scheduleDowngradeText": "<string>",
"scheduleUpgradeText": "<string>",
"seeMoreDetailsText": "<string>",
"seeMoreProductBtnText": "<string>",
"selectCancellationReasonLabelText": "<string>",
"selectDeliveryMethodLabel": "<string>",
"selectNewPlanText": "<string>",
"selectProductLabelText": "<string>",
"sendEmailTextV2": "<string>",
"shippingAddressLabel": "<string>",
"shippingLabelText": "<string>",
"shippingMethodLabel": "<string>",
"shippingOptionText": "<string>",
"showShipment": true,
"showUpcomingOrdersLabel": "<string>",
"skipBadgeText": "<string>",
"skipFirstPage": true,
"skipOrderButtonText": "<string>",
"subTotalLabelText": "<string>",
"subscriptionActivatedMessageText": "<string>",
"subscriptionDiscount": 123,
"subscriptionPausedMessageText": "<string>",
"subtotalLabel": "<string>",
"successStatusText": "<string>",
"successText": "<string>",
"topHtml": "<string>",
"totalPricePerDeliveryText": "<string>",
"translationUpdateRequest": {
"id": 123,
"value": "<string>"
},
"unableToUpdateSubscriptionStatusMessageText": "<string>",
"upSellMessage": "<string>",
"upcomingFulfillmentText": "<string>",
"upcomingOrderChangePopupFailureClosebtnText": "<string>",
"upcomingOrderChangePopupFailureDescriptionText": "<string>",
"upcomingOrderChangePopupFailureTitleText": "<string>",
"upcomingOrderChangePopupSuccessClosebtnText": "<string>",
"upcomingOrderChangePopupSuccessDescriptionText": "<string>",
"upcomingOrderChangePopupSuccessTitleText": "<string>",
"updateButtonText": "<string>",
"updateChangeOrderBtnText": "<string>",
"updateEditShippingButtonText": "<string>",
"updateShipmentBillingDate": true,
"upgradeBadgeText": "<string>",
"useUrlWithCustomerId": true,
"viewAttributeLabelText": "<string>",
"weekText": "<string>",
"weeksLabelText": "<string>",
"welcomeText": "<string>",
"yearText": "<string>",
"yearsLabelText": "<string>",
"yesBtnText": "<string>",
"yourAvailableRewardsPointsText": "<string>",
"yourRewardsText": "<string>",
"zipLabelText": "<string>"
}

Headers

X-API-Key
string

API Key for authentication (Preferred method - use this instead of api_key parameter)

Path Parameters

id
string
required

Shop identifier (typically shop domain)

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

Response

Customer portal settings successfully retrieved

amountLbl
string
required
cancelAccordionTitle
string
required
cancelFreqBtnText
string
required
cancelSubscriptionBtnText
string
required
cardExpiryText
string
required
cardHolderNameText
string
required
cardLastFourDigitText
string
required
cardTypeText
string
required
editFrequencyBtnText
string
required
nextOrderDateLbl
string
required
nextOrderText
string
required
noSubscriptionMessage
string
required
orderFrequencyText
string
required
orderNoLbl
string
required
paymentDetailAccordionTitle
string
required
paymentInfoText
string
required
paymentMethodTypeText
string
required
quantityLbl
string
required
shop
string
required
statusLbl
string
required
statusText
string
required
subscriptionNoText
string
required
totalProductsText
string
required
upcomingOrderAccordionTitle
string
required
updateFreqBtnText
string
required
updatePaymentBtnText
string
required
updatePaymentMessage
string
required
acceptBtnText
string
activeBadgeText
string
addAdditionalProduct
boolean
addNewButtonText
string
addOneTimeProduct
boolean
addProductButtonText
string
addProductFinishedMessageText
string
addProductLabelText
string
addProductOnlyForSameProductVariant
boolean
addToSubscriptionTitleCP
string
additionalFeedbackLabel
string
address1LabelText
string
address2LabelText
string
addressHeaderTitleText
string
afterCycleDiscountNoteDescription
string
allowCancellationBeforeDays
string
applySubscriptionDiscount
boolean
attributeHeadingText
string
attributeNameLabelText
string
attributeValue
string
backToAccountLabel
string
bottomHtml
string
cancelButtonText
string
cancelChangeOrderBtnText
string
cancelEditShippingButtonText
string
cancelPendingDowngradeBtnText
string
cancelPendingDowngradeText
string
cancelPendingUpgradeBtnText
string
cancelPendingUpgradeText
string
cancelSub
boolean
cancelSubscriptionConfirmPayAsYouGoText
string
cancelSubscriptionConfirmPrepaidText
string
cancelSubscriptionMinimumBillingIterationsMessage
string
cancelSubscriptionPayAsYouGoButtonText
string
cancelSubscriptionPrepaidButtonText
string
cancellationFeedbackLabelText
string
cancellationReasonLabelText
string
cancellationSecurityModalMessage
string
cancellationSecurityModalTitle
string
cancelledOnLabelText
string
changeNextOrderDate
boolean
changeOrderFrequency
boolean
changeShippingAddressFlag
boolean
changeVariantLabelText
string
chooseAnotherPaymentMethodText
string
choosePurchaseOptionLabelText
string
cityLabelText
string
clickHereText
string
closeBadgeText
string
closeBtnText
string
closeButtonLabel
string
companyLabelText
string
conformationPopupForCancellationDiscountText
string
continueButtonLabel
string
contractErrorMessageText
string
contractUpdateMessageText
string
countryCodeLabelText
string
countryLabelText
string
createAdditionalOrder
boolean
creditCardText
string
currentMembershipPlanText
string
currentMembershipText
string
customerIdText
string
customerPortalSettingJson
string
dateFormat
string
dayText
string
daysLabelText
string
deleteButtonText
string
deleteConfirmationMsgText
string
deleteMsgText
string
deleteProductFlag
boolean
deliverLabelText
string
deliveryFrequencyLabelText
string
deliveryPriceText
string
descriptionLength
string
discountCode
boolean
discountCodeApplyButtonText
string
discountCodeText
string
discountCouponAppliedText
string
discountMessageOnCancellation
string
discountNoteTitle
string
discountRecurringCycleLimitOnCancellation
integer<int32>
downgradeBadgeText
string
downgradeMembershipLabel
string
editChangeOrderBtnText
string
editProductButtonText
string
editProductFlag
boolean
editQuantityLabelText
string
editShippingModalLabel
string
enableMembershipHistory
boolean
enableRedirectMyAccountButton
boolean
enableShowProductDescription
boolean
enableViewAttributes
boolean
endingWithText
string
errorText
string
everyLabelText
string
expiredTokenText
string
failureStatusText
string
finishLabelText
string
firstNameLabelText
string
freezeOrderTillMinCycle
boolean
freezeUpdateSubscriptionMessage
string
fulfilledText
string
goBackButtonText
string
helloNameText
string
hideDetailsText
string
historyLabelText
string
id
integer<int64>
includeOutOfStockProduct
boolean
initialDiscountNoteDescription
string
lastAttemptDateLabelText
string
lastBillingAttemptFailedText
string
lastNameLabelText
string
loadMoreProductsText
string
loadingProductsText
string
localeDate
string
manageBtnText
string
manageSubscriptionButtonText
string
membershipExpireDescription
string
membershipExpireText
string
membershipPerksDetailsText
string
membershipSwap
enum<string>
Available options:
UPGRADE_ONLY,
DOWNGRADE_ONLY,
UPGRADE_AND_DOWNGRADE,
NONE
missedBillingAlertText
string
monthText
string
monthsLabelText
string
newPlanText
string
nextBtnText
string
nextDeliveryDate
string
noBtnText
string
noPaymentMethodFoundText
string
noProductsAvailableText
string
oneTimePurchaseDisplayMessageText
string
oneTimePurchaseMessageText
string
oneTimePurchaseNoteText
string
oneTimePurchaseTitleCP
string
openBadgeText
string
orderDateLabelText
string
orderNoLabelText
string
orderNoteFlag
boolean
orderNoteText
string
pauseBadgeText
string
pauseMembershipLabel
string
pauseMembershipMessageText
string
pauseResumeSub
boolean
pauseSubscriptionText
string
paymentNotificationText
string
pendingDowngradeTitleText
string
phoneLabelText
string
pleaseWaitLoaderText
string
preventCancellationBeforeDays
string
preventCancellationBeforeDaysMessage
string
previousBtnText
string
productAddMessageText
string
productConfirmationButtonLabel
string
productInSubscriptionText
string
productLabelText
string
productRemovedTooltip
string
productReplaceWarningText
string
productSelectionOption
enum<string>
Available options:
ALL_PRODUCTS,
PRODUCTS_FROM_ALL_PLANS,
PRODUCTS_FROM_CURRENT_PLAN
provinceCodeLabelText
string
provinceLabelText
string
purchaseOptionLabelText
string
queueBadgeText
string
redeemRewardsText
string
removeButtonText
string
removedTagOnFreeTrial
string
resumeMembershipLabel
string
resumeSub
boolean
resumeSubscriptionDescriptionText
string
resumeSubscriptionText
string
rewardsText
string
samePriceText
string
saveButtonLabel
string
scheduleDowngradeText
string
scheduleUpgradeText
string
seeMoreDetailsText
string
seeMoreProductBtnText
string
selectCancellationReasonLabelText
string
selectDeliveryMethodLabel
string
selectNewPlanText
string
selectProductLabelText
string
sendEmailTextV2
string
shippingAddressLabel
string
shippingLabelText
string
shippingMethodLabel
string
shippingOptionText
string
showShipment
boolean
showUpcomingOrdersLabel
string
skipBadgeText
string
skipFirstPage
boolean
skipOrderButtonText
string
subTotalLabelText
string
subscriptionActivatedMessageText
string
subscriptionDiscount
number<double>
subscriptionDiscountTypeUnit
enum<string>
Available options:
PERCENTAGE,
AMOUNT
subscriptionPausedMessageText
string
subtotalLabel
string
successStatusText
string
successText
string
topHtml
string
totalPricePerDeliveryText
string
translationUpdateRequest
object
unableToUpdateSubscriptionStatusMessageText
string
upSellMessage
string
upcomingFulfillmentText
string
upcomingOrderChangePopupFailureClosebtnText
string
upcomingOrderChangePopupFailureDescriptionText
string
upcomingOrderChangePopupFailureTitleText
string
upcomingOrderChangePopupSuccessClosebtnText
string
upcomingOrderChangePopupSuccessDescriptionText
string
upcomingOrderChangePopupSuccessTitleText
string
updateButtonText
string
updateChangeOrderBtnText
string
updateEditShippingButtonText
string
updateShipmentBillingDate
boolean
upgradeBadgeText
string
useUrlWithCustomerId
boolean
viewAttributeLabelText
string
weekText
string
weeksLabelText
string
welcomeText
string
yearText
string
yearsLabelText
string
yesBtnText
string
yourAvailableRewardsPointsText
string
yourRewardsText
string
zipLabelText
string