Skip to main content

Interface: CustomerPortalSettings

Properties​

available_products​

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

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

can_use_plans​

can_use_plans: boolean

Whether the store is using Plans and Products or not.

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.

discount_input​

discount_input: boolean

Allow the customer to add discount codes to their subscription.

edit_shipping_address​

edit_shipping_address: boolean

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

flows_enabled​

flows_enabled: boolean

Whether flows are enabled 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.

inventory_behaviour​

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

How does the store handles inventory policy *

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.

recurring_redemption​

recurring_redemption: string

The strategy for obtaining credits.

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.

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_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_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