APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships
Customer Portal Configuration
API Reference
Shipping & Delivery Profiles
Customer Discount History
Cancellation Flow Configuration
Billing & Orders
One-Time Add-Ons
Membership Plans
Product Bundles
Custom CSS Styling
Membership Contracts
Bundle Settings
Customer Payment Methods
Product Swap Rules
Subscription Contract Management
Subscription Billing
Billing Attempts
External (0.0.1)
Download OpenAPI description
Languages
Servers
https://membership-admin.appstle.com
Request
Retrieves customer portal configuration settings for the authenticated shop. These settings control the appearance, behavior, and text labels displayed in the customer self-service portal.
Key Settings Returned:
- UI Text Labels: Button text, form field labels, messages, tooltips
- Feature Toggles: Enable/disable portal features (shipping address edit, pause/resume, etc.)
- Branding: Custom HTML for header/footer, date formats, localization
- Cancellation Controls: Minimum days before cancellation, retention discounts
- Address Management: Shipping address field labels and configurations
- Discount Display: Discount note titles and descriptions for different cycles
- Product Management: Add product labels, variant change text, quantity controls
- Order Management: Order history labels, fulfillment status text
- Pause/Resume: Pause badge text, resume subscription messages
- Rewards Integration: Rewards text and points display labels
Common Use Cases:
- Retrieve portal settings for display in custom integrations
- Sync portal configuration with external systems
- Build custom customer portal interfaces using API-driven configuration
- Validate current portal settings programmatically
- Implement multi-language support by fetching localized labels
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
- https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://membership-admin.appstle.com/api/external/v2/customer-portal-settings/mystore.myshopify.com?api_key=string' \
-H 'X-API-Key: string'Response
application/json
{ "id": 0, "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", "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", "productSelectionOption": "ALL_PRODUCTS", "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, "subscriptionDiscountTypeUnit": "PERCENTAGE", "subscriptionDiscount": 0.1, "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": 0, "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", "membershipSwap": "UPGRADE_ONLY", "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", "editQuantityLabelText": "string" }