Skip to main content
GET
/
subscriptions
/
cp
/
api
/
customer-portal-settings
/
{id}
Get customer portal settings
curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/customer-portal-settings/{id}
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/customer-portal-settings/{id}"

response = requests.get(url)

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

fetch('https://www.myshop.com/apps/subscriptions/cp/api/customer-portal-settings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/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://www.myshop.com/apps/subscriptions/cp/api/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://www.myshop.com/apps/subscriptions/cp/api/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://www.myshop.com/apps/subscriptions/cp/api/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
{
  "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"
}
{
"detail": "Valid X-API-Key header is required",
"status": 401,
"title": "Authentication required",
"type": "https://example.com/errors/unauthorized"
}
{
"detail": "API key does not have permission to view portal settings",
"status": 403,
"title": "Insufficient permissions",
"type": "https://example.com/errors/forbidden"
}
{
"detail": "Customer portal settings have not been configured for this shop",
"status": 404,
"title": "Settings not found",
"type": "https://example.com/errors/not-found"
}

Path Parameters

id
string
required

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
activeBadgeText
string
addAdditionalProduct
boolean
addAdditionalProductInBAB
boolean
addDiscountCodeAlertText
string
addDiscountCodeText
string
addNewButtonText
string
addOneTimeProduct
boolean
addProductButtonText
string
addProductFinishedMessageText
string
addProductLabelText
string
addToOrderLabelText
string
addToSubscriptionDiscriptionTextV2
string
addToSubscriptionTitleCP
string
address1LabelText
string
address2LabelText
string
addressHeaderTitleText
string
afterCycleDiscountNoteDescription
string
aiAgentEnabled
boolean
aiAgentTier
string
allowAddOneTimeProductOrderIdPrepaid
boolean
allowAddRemoveSwapBeforeDays
string
allowCancelDuringFreeTrial
boolean
allowCancellationBeforeDays
string
allowDiscountCodeBeforeMinOrders
boolean
allowEditQuantityPrepaidSeparatePlan
boolean
allowOnlyOneTimeProductOnAddProductFlag
boolean
allowOrderNow
boolean
allowProductIdsForSubscriptionProductAdd
string
allowProductTagsForSubscriptionProductAdd
string
allowReschedulingContractTrialPeriod
boolean
allowSplitContract
boolean
allowSwapWhenContractIsFreeze
boolean
allowToAddProductQuantityMinMaxReached
boolean
allowToAutoAddProduct
boolean
allowToEditQuantityIfProductOutOfStock
boolean
allowToEditQuantityInSingleBABProduct
boolean
allowToSameReasonAgain
boolean
allowToSpecificZipCode
string
allowToSpecificZipCodeForLocalDelivery
string
allowedProductIdsForOneTimeProductAdd
string
amountTieredDiscountText
string
applySellingPlanBasedDiscount
boolean
applySubscriptionDiscount
boolean
applySubscriptionDiscountForOtp
boolean
areyousureCommonMessageText
string
areyousurePauseMessageText
string
areyousureResumeMessageText
string
attributeHeadingText
string
attributeNameLabelText
string
attributeValue
string
babProductBadgeTextV2
string
billingDateRestrictFromDate
string
billingDateRestrictToDays
integer<int32>
bottomHtml
string
cancelButtonText
string
cancelChangeOrderBtnText
string
cancelEditShippingButtonText
string
cancelSub
boolean
cancelSubscriptionConfirmPayAsYouGoText
string
cancelSubscriptionConfirmPrepaidText
string
cancelSubscriptionMinimumBillingIterationsMessage
string
cancelSubscriptionPayAsYouGoButtonText
string
cancelSubscriptionPrepaidButtonText
string
cancellationDateTitleText
string
cancellationNoteTitleText
string
changeAddressMessageOnPause
string
changeDateMessageOnPause
string
changeNextOrderDate
boolean
changeOrderFrequency
boolean
changePaymentMessage
string
changeShippingAddressFlag
boolean
changeVariantLabelText
string
chooseAnotherPaymentMethodTitleText
string
chooseDifferentProductActionText
string
chooseDifferentProductText
string
choosePurchaseOptionLabelText
string
cityLabelText
string
clickHereText
string
closeBadgeText
string
closeBtnText
string
companyLabelText
string
confirmAddProduct
string
confirmCommonText
string
confirmSkipFulfillmentBtnText
string
confirmSkipOrder
string
confirmSwapText
string
continueText
string
contractCancelledBadgeText
string
contractErrorMessageText
string
contractUpdateMessageText
string
countryCodeLabelText
string
countryLabelText
string
createAdditionalOrder
boolean
creditCardText
string
customJs
string
customerIdText
string
customerPortalLandingPage
string
customerPortalSettingJson
string
dateFormat
string
dayText
string
deleteButtonText
string
deleteConfirmationMsgText
string
deleteMsgText
string
deleteOneTimePurchaseProduct
boolean
deleteProductFlag
boolean
deleteProductTitleText
string
deliveryFrequencyText
string
deliveryPriceText
string
disAllowProductIdsForOneTimeProductAdd
string
disAllowProductTagsForSubscriptionProductAdd
string
disAllowVariantIdsForOneTimeProductAdd
string
disAllowVariantIdsForSubscriptionProductAdd
string
disableRescheduleTimeSelector
boolean
disabledKeyFieldFlag
boolean
discountAccordionTitle
string
discountAppliedTextV2
string
discountCarryForward
enum<string>
Available options:
NONE,
EXISTING_PLAN,
PRODUCT_PLAN,
PRODUCT_THEN_EXISTING
discountCode
boolean
discountCodeApplyButtonText
string
discountCodeText
string
discountCouponAppliedText
string
discountCouponNotAppliedText
string
discountCouponRemoveText
string
discountDetailsTitleText
string
discountMessageOnCancellation
string
discountMessageOnPause
string
discountNoteTitle
string
discountPercentageOnCancellation
string
discountRecurringCycleLimitOnCancellation
string
displayCountryByLanguage
boolean
editChangeOrderBtnText
string
editCommonText
string
editDeliveryInternalText
string
editProductButtonText
string
editProductFlag
boolean
editQuantityLabelText
string
emailAddressText
string
enableAllowOnlyOneDiscountCode
boolean
enableEditAttributes
boolean
enableEditOrderNotes
boolean
enableMergeContract
boolean
enableProductDescription
boolean
enableRedirectMyAccountButton
boolean
enableRedirectToProductPage
boolean
enableSkipFulFillment
boolean
enableSkipIndividualProduct
boolean
enableSplitContract
boolean
enableSwapProductFeature
boolean
enableSwapProductVariant
boolean
enableTabletForceView
boolean
enableUpdateDeliveryMethod
boolean
enableUpsellProducts
boolean
enableViewAttributes
boolean
endingWithText
string
everyLabelText
string
expiredTokenText
string
failureText
string
filterDeliveryFrequencyOnCustomerTags
boolean
finishLabelText
string
firstNameLabelText
string
freezeOrderTillMinCycle
boolean
freezeUpdateSubscriptionMessage
string
frequencyChangeWarningDescription
string
frequencyChangeWarningTitle
string
fromDeliveryDateAddDay
integer<int32>
fulfilledText
string
giftMessageOnPause
string
goBackButtonText
string
greetingText
string
hasBeenRemovedText
string
helloNameText
string
hideAddSubscriptionProductSection
boolean
hideAttributeAddition
boolean
hideDetailsText
string
hideHistoryTabNewCp
boolean
hideLoyaltyTable
boolean
hidePaymentMethodEdit
boolean
hideResumeButtonWhenMaxCycleReached
boolean
hideSchedulesTabNewCp
boolean
historyTabHeaderHTML
string
historyTabTitle
string
id
integer<int64>
includeOutOfStockProduct
boolean
initialDiscountNoteDescription
string
lastNameLabelText
string
localeDate
string
manageSubscriptionButtonText
string
maxCycleText
string
maxIterationReachedText
string
minCycleText
string
minProductsInSubscriptionContract
string
minQtyToAllowDuringAddProduct
integer<int32>
monthText
string
multiCurrencyAvailable
boolean
nextBtnText
string
nextDeliveryDate
string
nextTierAmountTieredDiscountText
string
nextTierPercentageTieredDiscountText
string
noBtnText
string
noDeliveryMethodLabelText
string
noOrderNotAvailableMessage
string
offerDiscountOnCancellation
boolean
oneTimePurchaseDisplayMessageText
string
oneTimePurchaseMessageText
string
oneTimePurchaseNoteText
string
oneTimePurchaseOnlyText
string
oneTimePurchaseTitleCP
string
openBadgeText
string
orderDateText
string
orderNoteFlag
boolean
orderNoteText
string
orderNowDescriptionText
string
orderNowText
string
orderTotalText
string
overrideDaysToRescheduleOrder
boolean
pauseAccordionTitle
string
pauseBadgeText
string
pauseMessageOnPause
string
pauseNoteTitleText
string
pauseResumeSub
boolean
pauseSubscriptionText
string
pauseTillDateTitleText
string
paymentNotificationText
string
paypalLblText
string
percentageTieredDiscountText
string
phoneLabelText
string
pleaseSelectText
string
pleaseWaitLoaderText
string
popUpErrorMessage
string
popUpSuccessMessage
string
preventAddRemoveSwapBeforeDays
string
preventCancellationBeforeDays
string
preventCancellationBeforeDaysMessage
string
preventChildProductSwap
boolean
previousBtnText
string
priceLbl
string
productAddMessageText
string
productFilterConfig
string
productInSubscriptionText
string
productLabelText
string
productLblText
string
productRemovedTooltip
string
productSelectionOption
enum<string>
Available options:
ALL_PRODUCTS,
PRODUCTS_FROM_ALL_PLANS,
PRODUCTS_FROM_CURRENT_PLAN
provinceCodeLabelText
string
provinceLabelText
string
purchaseOptionLabelText
string
queueBadgeText
string
redeemRewardsTextV2
string
removeDiscountCodeAlertText
string
removeDiscountCodeAutomatically
boolean
removeDiscountCodeLabel
string
removeSwapSourceProductLimit
boolean
requireFieldMessage
string
rescheduleOrderDescription
string
rescheduleText
string
reschedulingPolicies
string
resumeSub
boolean
resumeSubAfterCancellation
boolean
resumeSubscriptionText
string
retryFailedOrderConfirmationTextV2
string
retryFailedOrderDescriptionTextV2
string
rewardsTextV2
string
saveButtonText
string
scheduledTabTitle
string
schedulesTabHeaderHTML
string
searchProductBtnText
string
sectionMinMaxTextV2
string
sectionTitleText
string
sectionedBabBadgeText
string
seeMoreDetailsText
string
seeMoreProductBtnText
string
selectCancellationReasonLabelText
string
selectPaymentMethodTitleText
string
selectProductLabelText
string
selectProductToAdd
string
selectSplitMethodLabelText
string
selectedCancellationReasonTitleText
string
selectedPauseReasonTitleText
string
selectedProductLabelTextV2
string
sellingPlanFrequencyOptionMode
enum<string>
Available options:
LEGACY_UNION,
COMPATIBLE_ONLY
sellingPlanNameText
string
sendEmailText
string
shippingAddressNotAvailableText
string
shippingLabelText
string
shippingOptionText
string
shopCustomizationData
object[]
shopPayLblText
string
shopPayPaymentUpdateText
string
showNextOrderDeliveryDate
boolean
showSellingPlanFrequencies
boolean
showShipment
boolean
singleBABDeletedProductPlaceholderImage
string
skipBadgeText
string
skipDaysFromCurrentDate
integer<int32>
skipDaysToCurrentDate
integer<int32>
skipFulfillmentButtonText
string
skipMessageOnPause
string
skipOrderButtonText
string
splitContractConfirmButtonText
string
splitContractMessage
string
splitContractNoteText
string
splitContractText
string
splitWithOrderPlacedSelectOptionHelpText
string
splitWithOrderPlacedSelectOptionText
string
splitWithoutOrderPlacedSelectOptionHelpText
string
splitWithoutOrderPlacedSelectOptionText
string
subTotalLabelText
string
subscriptionActivatedMessageText
string
subscriptionContractFreezeMessage
string
subscriptionDiscount
number<double>
subscriptionDiscountTypeUnit
enum<string>
Available options:
PERCENTAGE,
AMOUNT
subscriptionPausedMessageText
string
successText
string
swapMessageOnPause
string
swapProductBtnText
string
swapProductLabelText
string
swapProductSearchBarText
string
toDeliveryDateAddDay
integer<int32>
topHtml
string
totalLblText
string
totalPricePerDeliveryText
string
unableToUpdateSubscriptionStatusMessageText
string
unknownPaymentReachoutUsText
string
upSellMessage
string
upcomingFulfillmentText
string
upcomingOrderChangePopupFailureClosebtnText
string
upcomingOrderChangePopupFailureDescriptionText
string
upcomingOrderChangePopupFailureTitleText
string
upcomingOrderChangePopupSuccessClosebtnText
string
upcomingOrderChangePopupSuccessDescriptionText
string
upcomingOrderChangePopupSuccessTitleText
string
upcomingOrderPlaceNowAlertText
string
upcomingOrderSkipAlertText
string
upcomingTabHeaderHTML
string
upcomingTabTitle
string
updateButtonText
string
updateChangeOrderBtnText
string
updateEditShippingButtonText
string
updateFrequencyMessageOnPause
string
updatePaymentMethodTitleText
string
updateShipmentBillingDate
boolean
useUrlWithCustomerId
boolean
validEmailMessage
string
validNumberRequiredMessage
string
variantIdsToFreezeEditRemove
string
variantLbl
string
variantLblText
string
viewAttributeLabelText
string
viewMoreText
string
weekText
string
welcomeText
string
yearText
string
yesBtnText
string
yourAvailableRewardsPointsTextV2
string
yourRewardsTextV2
string
zipLabelText
string