Skip to main content

Interface: CustomerPortalSettings

Properties​

affinity_bundle_contents_expanded_by_default​

affinity_bundle_contents_expanded_by_default: BooleanNumbers

Whether Affinity bundle contents are expanded by default or not.

affinity_manage_upcoming_products_enabled​

affinity_manage_upcoming_products_enabled: BooleanNumbers

Whether Affinity manage upcoming products is enabled or not.

affinity_plans​

affinity_plans: boolean

Whether Affinity plans are enabled or not.

affinity_poll_charge_uncommited_changes​

affinity_poll_charge_uncommited_changes: boolean

Whether Affinity polls for uncommitted charge changes or not.

affinity_sidebar_position​

affinity_sidebar_position: "right" | "left"

The position of the Affinity sidebar.

ai_chat_enabled​

ai_chat_enabled: boolean

Whether AI chat is enabled or not.

ai_chat_preview_enabled​

ai_chat_preview_enabled: boolean

Whether AI chat preview is enabled or not.

always_send_plan_id_for_updates​

always_send_plan_id_for_updates: boolean

Whether to always send plan ID for updates or not.

available_products​

available_products: "all" | "specific_recharge_collections" | "specific_plan_types" | "smart_select"

The filter of products that are available to create new subscriptions.

backup_payment_methods_settings​

backup_payment_methods_settings: object

Settings related to backup payment methods

backup_payment_methods_enabled​

backup_payment_methods_enabled: boolean

default_customer_opt_in_enabled​

default_customer_opt_in_enabled: boolean

can_use_affinity_extensions​

can_use_affinity_extensions: boolean

Whether the store can use Affinity extensions or not.

can_use_plans​

can_use_plans: boolean

Whether the store is using Plans and Products or not.

cancelation_type​

cancelation_type: "Basic" | "Strategy"

The type of cancellation flow used by the store.

collection_ids​

collection_ids: number[]

The Recharge collection IDs in case the products available for purchase are limited to specific Recharge collections.

collection_product_sorting_enabled​

collection_product_sorting_enabled: boolean

Whether the store is using collections with custom sorting or not.

custom_code​

custom_code: object

Custom code snippets for the customer portal.

approved_domains_for_csp​

approved_domains_for_csp: string

Approved domains for Content Security Policy.

backend_portal​

backend_portal: string

Custom code for the backend portal.

credit_cart_update_page​

credit_cart_update_page: string

Custom code for the credit cart update page.

footer: string

Custom code for the footer section.

header: string

Custom code for the header section.

header_logo_url​

header_logo_url: string

URL for the custom header logo.

customer_payment_fallback_enabled​

customer_payment_fallback_enabled: boolean

Whether customer payment fallback is enabled or not.

disable_referrals_mobile_banner​

disable_referrals_mobile_banner: boolean

Whether referrals mobile banner is disabled or not.

discount_input​

discount_input: boolean

Allow the customer to add discount codes to their subscription.

edit_shipping_address​

edit_shipping_address: BooleanNumbers

Allow the customer to modify the shipping address for an existing subscription.

enable_affinity_use_storefront_api​

enable_affinity_use_storefront_api: boolean

Whether Affinity uses Storefront API or not.

enable_customer_account_full_page_extension​

enable_customer_account_full_page_extension: boolean

Whether the store is using the customer portal extension or not.

enable_enhanced_slots​

enable_enhanced_slots: boolean

Whether enhanced slots are enabled or not.

enable_market_pricing​

enable_market_pricing: boolean

Whether market pricing is enabled or not.

enable_membership_programs​

enable_membership_programs: boolean

Whether membership programs are enabled or not.

enable_paid_memberships_ui​

enable_paid_memberships_ui: boolean

Whether paid memberships UI is enabled or not.

enable_quantity_upsell_ui_affinity​

enable_quantity_upsell_ui_affinity: boolean

Whether quantity upsell UI is enabled in Affinity or not.

enable_scim_migrate_payment_methods​

enable_scim_migrate_payment_methods: boolean

Whether the store is using SCIm migrate payments.

enable_shopify_markets​

enable_shopify_markets: boolean

Whether the store is using Shopify Markets or not.

enable_swap_always_pass_plan​

enable_swap_always_pass_plan: boolean

Whether to always pass plan when swapping or not.

enable_unity_bundles​

enable_unity_bundles: boolean

Whether the store is using Unity integrated bundles or not.

failed_payment_recovery_enabled​

failed_payment_recovery_enabled: boolean

Whether failed payment recovery is enabled or not.

flows_allow_hidden_products_to_be_shown​

flows_allow_hidden_products_to_be_shown: boolean

Whether flows allow hidden products to be shown or not.

flows_enabled​

flows_enabled: boolean

Whether flows are enabled or not.

force_customer_portal_accounts​

force_customer_portal_accounts: BooleanNumbers

Whether customer portal accounts are forced or not.

fpr_affinity_show_errors_payments_page​

fpr_affinity_show_errors_payments_page: boolean

Whether Affinity shows errors on the payments page or not.

gift_skipped_shipment_enabled​

gift_skipped_shipment_enabled: boolean

Whether customers can skip gift shipment or not.

gifting​

gifting: object

Settings related to gifting.

cancel_sub_on_gift_end​

cancel_sub_on_gift_end: boolean

Cancels the subscriptions when gifting finishes.

enabled​

enabled: boolean

Whether gifting is enabled or not.

fulfill_orders_on_redemption​

fulfill_orders_on_redemption: boolean

Fulfill the order when the gift is redeemed.

redemption_ui_platform​

redemption_ui_platform: string

The platform where the gift redemption is happening.

select_onetime​

select_onetime: number

Whether the customer can select onetime products when gifting or not.

select_quantity​

select_quantity: number

Whether the customer can select the quantity when gifting or not.

gifting_enabled​

gifting_enabled: boolean

Whether gifting is enabled or not.

hosted_customer_portal​

hosted_customer_portal: BooleanNumbers

Whether the store uses a hosted customer portal or not.

inventory_behaviour​

inventory_behaviour: "bypass" | "decrement_ignoring_policy" | "decrement_obeying_policy"

How does the store handles inventory policy *

membership​

membership: object

Settings related to membership programs.

allow_membership_cancellation_after​

allow_membership_cancellation_after: number

Number of orders before allowing membership cancellation.

allow_membership_cancellation_in_customer_portal​

allow_membership_cancellation_in_customer_portal: BooleanNumbers

Whether membership cancellation is allowed in the customer portal.

membership_cancellation_reason_optional​

membership_cancellation_reason_optional: BooleanNumbers

Whether membership cancellation reason is optional or not.

onetime​

onetime: object

Settings related to one-time purchases.

available_products​

available_products: "shopify_products" | "recharge_products" | "shopify_collection" | "recharge_collection"

The filter of products that are available for one-time purchases.

enabled​

enabled: BooleanNumbers

Whether one-time purchases are enabled or not.

shopify_collection_id​

shopify_collection_id: number

The Shopify collection ID for one-time products.

subscribe_and_save_discount_enabled​

subscribe_and_save_discount_enabled: boolean

Whether subscribe and save discount is enabled or not.

zero_inventory_purchase​

zero_inventory_purchase: BooleanNumbers

Whether the customer can purchase a zero inventory product or not.

prevent_address_creation​

prevent_address_creation: boolean

Whether the customer can create a new address or use their default.

prevent_payment_method_creation​

prevent_payment_method_creation: boolean

Whether the customer can create a new payment method or use their default.

recharge_credits_settings​

recharge_credits_settings: object

Settings related to credits.

discount_name​

discount_name: string

Contains the discount name.

multicurrency_redemption_enabled​

multicurrency_redemption_enabled: boolean

Wether multicurrency redemption is enabled or not.

recurring_redemption​

recurring_redemption: "automatic" | "accumulation" | "off"

The strategy for obtaining credits.

recurring_order_blocking​

recurring_order_blocking: boolean

Whether recurring order blocking is enabled or not.

show_credits​

show_credits: boolean

Whether to show credits or not.

subscription​

subscription: object

Subscription related settings

add_product​

add_product: boolean

Whether the customer can create new subscriptions or not.

cancel_subscription​

cancel_subscription: boolean

Whether the customer can cancel their subscription or not.

cancellation_email_contact​

cancellation_email_contact: string

The email to contact when cancelling a subscription.

cancellation_enable_pause_options​

cancellation_enable_pause_options: boolean

Whether the customer can pause their subscriptions or not.

cancellation_enable_pause_options_values​

cancellation_enable_pause_options_values: string

The options for pausing a subscription.

cancellation_minimum_order_count​

cancellation_minimum_order_count: number

The minimum order count for cancelling a subscription.

cancellation_reason_optional​

cancellation_reason_optional: boolean

Whether the cancellation reason is optional or not.

change_frequency_recalculate_next_charge​

change_frequency_recalculate_next_charge: boolean

Whether the next charge should be recalculated when changing the frequency or not.

change_product​

change_product: boolean

Whether the customer can swap the subscription product or not.

change_quantity​

change_quantity: boolean

Whether the customer can change the quantity of the subscription or not.

change_variant​

change_variant: boolean

Whether the customer can swap the variant of the subscription or not.

edit_order_frequency​

edit_order_frequency: string

Whether the customer can change the subscription frequency or not.

edit_scheduled_date​

edit_scheduled_date: boolean

Whether the customer can change the scheduled date for a charge or not.

enable_affinity_dynamic_bundle_frequency_filter​

enable_affinity_dynamic_bundle_frequency_filter: boolean

Whether Affinity dynamic bundle frequency filter is enabled or not.

prepaid_upsell_on_customer_portal​

prepaid_upsell_on_customer_portal: boolean

Whether the customer can see the prepaid upsell on the customer portal or not.

reactivate_subscription​

reactivate_subscription: boolean

Whether the customer can reactivate a cancelled subscription.

skip_prepaid_order​

skip_prepaid_order: boolean

Whether the customer can skip a prepaid order or not.

skip_scheduled_order​

skip_scheduled_order: boolean

Whether the customer can skip a scheduled order or not.

zero_inventory_purchase​

zero_inventory_purchase: boolean

Whether the customer can purchase a zero inventory product or not.

use_recharge_inventory_levels​

use_recharge_inventory_levels: boolean

Uses the inventory level from Recharge as source of truth

use_spreedly_form_for_sci_payment_methods​

use_spreedly_form_for_sci_payment_methods: boolean

Use Spreedly instead of Shopify Payments when creating a new payment method.

view_memberships​

view_memberships: BooleanNumbers

The customer can see memberships

view_order_schedule​

view_order_schedule: boolean

The customer can see the order schedule

view_recharge_payment_methods​

view_recharge_payment_methods: boolean

The customer can see the payment methods

view_subscriptions​

view_subscriptions: boolean

The customer can see the subscriptions

wfs_active_churn​

wfs_active_churn: boolean

Uses Flows Active Churn Recovery

wfs_active_churn_landing_page_redirect​

wfs_active_churn_landing_page_redirect: boolean

Should redirect to ACR landing page

wfs_cp_show_sd​

wfs_cp_show_sd: boolean

Whether to show scheduled date in customer portal or not.

wfs_experiences_landing_page​

wfs_experiences_landing_page: boolean

Uses Flows Experiences

wfs_flows_enabled​

wfs_flows_enabled: boolean

Uses Flows

wfs_klaviyo_sender​

wfs_klaviyo_sender: boolean

Ignores restricted keywords for the store in Klaviyo