My Subscriptions Widget - Configuration Reference


The My Subscriptions Widget supports extensive configuration options. Below is a complete reference to all the supported options.

You might also want to take a look at a complete default configuration.

Base Configuration Options

These options allow you to configure the Subscribe Pro API connection, credentials and options global to the entire widget.

Config KeyDetails
versionint
Default: 2
apiBaseUrlstring
Default: 'https://api.subscribepro.com'
apiAccessTokenstring
Default: 
vaultEnvironmentKeystring
Default: 
customerIdstring
Default: '0'
themeNamestring
Default: 'base'

UI Section-Specific Configuration

There are many configuration options available for each section of the main user interface (UI) for the My Subscriptions Widget.

Config KeyDetails

Summary text at top of widget "Well automatically send..."

Config KeyDetails
summary.showbool
Default: true
summary.line2Textstring
Default: 'We'll automatically send you recurring shipments.'

Control what is displayed when there are no subscriptions for this customer

Config KeyDetails
noSubscriptions.textstring
Default: 'You are not currently subscribed to any items.'

Product Info Section

Config KeyDetails

Config KeyDetails
productInfo.price.currencystring
Default: 'USD'
productInfo.price.fractionDigitsint
Default: 0

Quantity Selection Section

Config KeyDetails
quantity.showstring
Default: ''
quantity.allowEditstring
Default: ''
quantity.labelTextstring
Default: 'Qty'

Next Order Date Selection Section

Config KeyDetails
nextDate.showbool
Default: true
nextDate.allowEditbool
Default: true
nextDate.labelTextstring
Default: 'Next Delivery'

See - https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md

Config KeyDetails
nextDate.datepickerOptions.localestring
Default: 'en'
nextDate.datepickerOptions.dateFormatstring
Default: 'LLL d, yyyy'

Frequency Selection Section

Config KeyDetails
frequency.showbool
Default: true
frequency.allowEditbool
Default: true
frequency.labelTextstring
Default: 'Send Every'

Coupon Section

Config KeyDetails
fixedPrice.showbool
Default: false
fixedPrice.allowEditbool
Default: true
fixedPrice.editLinkTextstring
Default: 'Change'

Config KeyDetails
actions.showActionsarray
Default: 
actions.showActionsPhonearray
Default: 

Config KeyDetails

Config KeyDetails
actions.actions.skip.typestring
Default: 'button'
actions.actions.skip.typePhonestring
Default: 'button'
actions.actions.skip.labelstring
Default: 'Skip'
actions.actions.skip.labelPhonestring
Default: 'Skip Next Delivery'

Config KeyDetails
actions.actions.pause.typestring
Default: 'button'
actions.actions.pause.typePhonestring
Default: 'button'
actions.actions.pause.labelstring
Default: 'Pause'
actions.actions.pause.labelPhonestring
Default: 'Pause Delivery'

Config KeyDetails
actions.actions.cancel.typestring
Default: 'link'
actions.actions.cancel.typePhonestring
Default: 'link'
actions.actions.cancel.labelstring
Default: 'Stop'
actions.actions.cancel.labelPhonestring
Default: 'Stop Delivery'

Config KeyDetails
actions.actions.restart.typestring
Default: 'button'
actions.actions.restart.typePhonestring
Default: 'button'
actions.actions.restart.labelstring
Default: 'Restart'
actions.actions.restart.labelPhonestring
Default: 'Restart'

Coupon Section

Config KeyDetails
coupon.showbool
Default: true
coupon.labelTextstring
Default: 'Coupon Code'
coupon.labelTextNoCodestring
Default: 'Got a Coupon Code?'

Shipping Address Section

Config KeyDetails
shipping.showbool
Default: true
shipping.labelTextstring
Default: 'Shipping Address'

Billing Address Section

Config KeyDetails
billing.showbool
Default: false
billing.labelTextstring
Default: 'Billing Address'

Expander Control

Config KeyDetails
expander.collapsedTextstring
Default: 'Payment & Shipping'
expander.collapsedTextPhonestring
Default: 'Show Details'
expander.expandedTextstring
Default: 'Hide Details'
expander.expandedTextPhonestring
Default: 'Hide Details'