Bold Subscriptions allows your customers to manage their own subscriptions through a dedicated page called the Customer Portal. Through this page, your customers can adjust their subscription information depending on the permissions you've enabled in the Customer Portal settings.
Your customers can access the Customer Portal by logging into their BigCommerce account on your store. Please visit Managing Customer Accounts on BigCommerce for more information.
This article will walk you through the setup so your customers can access the Customer Portal to manage their subscriptions.
Caution
The ability to log in to the Customer Portal as the customer will not work if the setting Restrict to Customer Only is selected. Please ensure this setting is not selected if you wish to use this feature.
- From BigCommerce's admin, select Storefront.
- Select Web Pages.
- Select Create a Web Page.
- Under Page Type, select Contain content created using the WYSIWYG editor below.
- Enter a Page Name.
Note: We suggest naming this page the My Subscriptions.
- In the Page Content section, select HTML.
- Copy and paste the following code into the HTML editor:
<div id="customer-portal-root"></div> - Select Update.
- Select Save & Exit.
Customizations
The Customer Portal supports the ability to change its default text or add translations for other languages.
Caution
This customization requires developer knowledge. It is highly recommended to have a developer assist you.
You can manage the Customer Portal's language changes and translations by setting window.BOLD.subscriptions.config.internationalization to an object within your shop's theme, with the following shape:
| Key | Type | Shape |
| {language_code'} | Object |
The ISO 639-1 language code to configure internationalization data for. (en = English, fr = French, es = Spanish, etc.) |
| {language_code}.translation | Object | The key containing the translations for the parent language code. |
| {language_code}.translation.{translation_key} | String |
The translation value for a specific key. Learn more about translation values below. |
A full list of available translation keys and their default values can be found in the window.BOLD.subscriptions.config.internationalizationDefaults object on your storefront.
Example
Setting the en and fr translation of the orderFrequencyTitle key:
window.BOLD.subscriptions.config.internationalization = {
en: {
translation: {
subscriptionSummaryOrderFrequencyTitle: 'Order frequency'
}
},
fr: {
translation: {
subscriptionSummaryOrderFrequencyTitle: 'Récurrence des commandes'
}
}
}
Translation Values
- Translation values may contain interpolation values denoted by keys within double curly brace brackets (eg. "The value is {{value}}".) Use the default translation values to guide what interpolation keys are available for each translation key.
- Some translation keys allow an extra key with a _plural suffix to be specified which allows different translations for different counts of the translation subject. For languages requiring more than simple singular and plural translations _0, _1, _2, _n suffixes can also be used.
- Formats of dates can be altered by adding the format after a comma when using an interpolation value (eg. {{date,MMMM DD, YYYY}}). For a full reference of available date format tokens, please view this list.
Language Detection and Fallback
When multiple languages are provided the customer portal will automatically detect the customer's language and chooses the best translations to use from the available options. When customers view your customer portal with a locale not defined in the translations for their language they are given the en translation by default. You can set the window.BOLD.subscriptions.config.internationalizationFallbackLanguage variable to an ISO 639-1 language code to change the fallback language of the customer portal.
Programmatically Changing Languages
If you would like to change the current language of the customer portal in Javascript you can do so using the window.BOLD.subscriptions.changeLanguage(languageCode) method.
Testing Other Languages
You can force the customer portal to display the translations for another language by setting the lng query param in your url to an ISO 639-1 language code. For example, your-shop-url.com/pages/customer-portal?lng=fr.