Skip to content
👤 Customer Portal APIs
/
Customer Portal Configura...
/
getCustomerPortalSettings

Customer Portal APIs (0.0.1)

Important Note:

The APIs in this document are for reference only and will not work directly in Swagger. To use these APIs, you need to call them from your shop.

The base URL for these APIs is your shop's domain. For example, if your shop domain is https://www.myshop.com/apps, then the full API endpoint will be based on this domain (e.g., https://www.myshop.com/apps/memberships/cp/api/**).

Please ensure the customer is logged in when calling the Customer Portal Proxy API. If the customer is not logged in, the API will return a 401 Unauthorized error.

Download OpenAPI description
storefront-api-swagger.json
storefront-api-swagger.yaml
Languages
Servers
https://www.myshop.com/apps

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

getCustomerPortalSettings

Request

Path
idstringrequired
curl -i -X GET \
  'https://www.myshop.com/apps/memberships/cp/api/customer-portal-settings/{id}'

Responses

OK

Body*/*
idinteger(int64)
shopstringrequired
orderFrequencyTextstringrequired
totalProductsTextstringrequired
nextOrderTextstringrequired
statusTextstringrequired
cancelSubscriptionBtnTextstringrequired
noSubscriptionMessagestringrequired
subscriptionNoTextstringrequired
updatePaymentMessagestringrequired
cardLastFourDigitTextstringrequired
cardExpiryTextstringrequired
cardHolderNameTextstringrequired
cardTypeTextstringrequired
paymentMethodTypeTextstringrequired
cancelAccordionTitlestringrequired
paymentDetailAccordionTitlestringrequired
upcomingOrderAccordionTitlestringrequired
paymentInfoTextstringrequired
updatePaymentBtnTextstringrequired
nextOrderDateLblstringrequired
statusLblstringrequired
quantityLblstringrequired
amountLblstringrequired
orderNoLblstringrequired
editFrequencyBtnTextstringrequired
cancelFreqBtnTextstringrequired
updateFreqBtnTextstringrequired
pauseResumeSubboolean
changeNextOrderDateboolean
cancelSubboolean
changeOrderFrequencyboolean
createAdditionalOrderboolean
manageSubscriptionButtonTextstring
editChangeOrderBtnTextstring
cancelChangeOrderBtnTextstring
updateChangeOrderBtnTextstring
editProductButtonTextstring
deleteButtonTextstring
updateButtonTextstring
cancelButtonTextstring
addProductButtonTextstring
downgradeMembershipLabelstring
addProductLabelTextstring
activeBadgeTextstring
closeBadgeTextstring
skipOrderButtonTextstring
productLabelTextstring
seeMoreDetailsTextstring
hideDetailsTextstring
productInSubscriptionTextstring
subTotalLabelTextstring
paymentNotificationTextstring
editProductFlagboolean
deleteProductFlagboolean
showShipmentboolean
addAdditionalProductboolean
successTextstring
cancelSubscriptionConfirmPrepaidTextstring
cancelSubscriptionConfirmPayAsYouGoTextstring
cancelSubscriptionPrepaidButtonTextstring
cancelSubscriptionPayAsYouGoButtonTextstring
upcomingFulfillmentTextstring
creditCardTextstring
endingWithTextstring
weekTextstring
dayTextstring
monthTextstring
yearTextstring
skipBadgeTextstring
queueBadgeTextstring
shippingLabelTextstring
address1LabelTextstring
address2LabelTextstring
companyLabelTextstring
cityLabelTextstring
countryLabelTextstring
firstNameLabelTextstring
lastNameLabelTextstring
phoneLabelTextstring
provinceLabelTextstring
zipLabelTextstring
addressHeaderTitleTextstring
changeShippingAddressFlagboolean
updateEditShippingButtonTextstring
cancelEditShippingButtonTextstring
pauseSubscriptionTextstring
resumeSubscriptionTextstring
pauseBadgeTextstring
customerPortalSettingJsonstring
discountNoteTitlestring
initialDiscountNoteDescriptionstring
afterCycleDiscountNoteDescriptionstring
productRemovedTooltipstring
deliveryPriceTextstring
shippingOptionTextstring
nextDeliveryDatestring
everyLabelTextstring
orderNoteFlagboolean
orderNoteTextstring
useUrlWithCustomerIdboolean
expiredTokenTextstring
portalLoginLinkTextstring
localeDatestring
productSelectionOptionstring
Enum"ALL_PRODUCTS""PRODUCTS_FROM_ALL_PLANS""PRODUCTS_FROM_CURRENT_PLAN"
includeOutOfStockProductboolean
customerIdTextstring
helloNameTextstring
goBackButtonTextstring
changeVariantLabelTextstring
provinceCodeLabelTextstring
countryCodeLabelTextstring
pleaseWaitLoaderTextstring
openBadgeTextstring
cancelSubscriptionMinimumBillingIterationsMessagestring
topHtmlstring
bottomHtmlstring
updateShipmentBillingDateboolean
discountCodeTextstring
discountCodeApplyButtonTextstring
discountCodeboolean
applySubscriptionDiscountboolean
subscriptionDiscountTypeUnitstring
Enum"PERCENTAGE""AMOUNT"
subscriptionDiscountnumber(double)
upSellMessagestring
freezeOrderTillMinCycleboolean
freezeUpdateSubscriptionMessagestring
addOneTimeProductboolean
selectProductLabelTextstring
purchaseOptionLabelTextstring
finishLabelTextstring
nextBtnTextstring
previousBtnTextstring
closeBtnTextstring
deleteConfirmationMsgTextstring
deleteMsgTextstring
yesBtnTextstring
noBtnTextstring
oneTimePurchaseNoteTextstring
clickHereTextstring
productAddMessageTextstring
choosePurchaseOptionLabelTextstring
oneTimePurchaseMessageTextstring
contractUpdateMessageTextstring
oneTimePurchaseDisplayMessageTextstring
addProductFinishedMessageTextstring
contractErrorMessageTextstring
addToSubscriptionTitleCPstring
oneTimePurchaseTitleCPstring
seeMoreProductBtnTextstring
totalPricePerDeliveryTextstring
fulfilledTextstring
dateFormatstring
discountCouponAppliedTextstring
subscriptionPausedMessageTextstring
subscriptionActivatedMessageTextstring
unableToUpdateSubscriptionStatusMessageTextstring
selectCancellationReasonLabelTextstring
upcomingOrderChangePopupSuccessTitleTextstring
upcomingOrderChangePopupSuccessDescriptionTextstring
upcomingOrderChangePopupSuccessClosebtnTextstring
upcomingOrderChangePopupFailureTitleTextstring
upcomingOrderChangePopupFailureDescriptionTextstring
upcomingOrderChangePopupFailureClosebtnTextstring
viewAttributeLabelTextstring
attributeNameLabelTextstring
attributeValuestring
addNewButtonTextstring
attributeHeadingTextstring
enableViewAttributesboolean
addProductOnlyForSameProductVariantboolean
enableMembershipHistoryboolean
enableShowProductDescriptionboolean
descriptionLengthstring
historyLabelTextstring
orderNoLabelTextstring
orderDateLabelTextstring
lastAttemptDateLabelTextstring
membershipExpireTextstring
membershipExpireDescriptionstring
discountRecurringCycleLimitOnCancellationinteger(int32)
discountMessageOnCancellationstring
conformationPopupForCancellationDiscountTextstring
enableResendMagicLinkboolean
redeemRewardsTextstring
rewardsTextstring
yourRewardsTextstring
yourAvailableRewardsPointsTextstring
productReplaceWarningTextstring
additionalFeedbackLabelstring
backToAccountLabelstring
missedBillingAlertTextstring
acceptBtnTextstring
cancelledOnLabelTextstring
cancellationReasonLabelTextstring
cancellationFeedbackLabelTextstring
preventCancellationBeforeDaysMessagestring
membershipSwapstring
Enum"UPGRADE_ONLY""DOWNGRADE_ONLY""UPGRADE_AND_DOWNGRADE""NONE"
retrieveMagicLinkDescriptionstring
retrieveMagicLinkTextstring
lastBillingAttemptFailedTextstring
preventCancellationBeforeDaysstring
allowCancellationBeforeDaysstring
enableRedirectMyAccountButtonboolean
goBackRedirectLinkstring
resumeSubboolean
deliveryFrequencyLabelTextstring
deliverLabelTextstring
daysLabelTextstring
weeksLabelTextstring
monthsLabelTextstring
yearsLabelTextstring
removedTagOnFreeTrialstring
chooseAnotherPaymentMethodTextstring
editShippingModalLabelstring
continueButtonLabelstring
selectDeliveryMethodLabelstring
saveButtonLabelstring
showUpcomingOrdersLabelstring
shippingAddressLabelstring
shippingMethodLabelstring
subtotalLabelstring
resumeMembershipLabelstring
closeButtonLabelstring
pauseMembershipLabelstring
pauseMembershipMessageTextstring
noPaymentMethodFoundTextstring
membershipPerksDetailsTextstring
resumeSubscriptionDescriptionTextstring
skipFirstPageboolean
welcomeTextstring
removeButtonTextstring
productConfirmationButtonLabelstring
editQuantityLabelTextstring

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

Product & Inventory Data

APIs for retrieving product catalog, variants, pricing, and inventory information for subscription memberships

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

loyalty-integration-resource

Operations

customer-retention-activity-resource

Operations

shop-info-resource

Operations