The Younium Self Service Hub

The Younium Self Service Hub is a configuration cockpit for tenant administrators to enable hosted portal features, distribute embedded components, and manage API access. It serves as the authoritative source for settings that other components consume, including portal branding, enabled features, email templates, and API credentials.

What You’ll Find Here

This guide covers:

  • Logging In – Accessing the Self-Service Hub
  • Dashboard Overview – Understanding the main interface
  • Younium API Configuration – Connecting to your Younium instance
  • Portal Settings – Configuring the hosted customer portal
  • Customer Users – Managing portal user access
  • Subscription management - Enabling your products to the end users.
  • Email Templates – Customizing transactional emails
  • API Credentials – Setting up credentials for embedded components
  • Embedded Components – Understanding available components and integration
  • Activity Log – Tracking platform activities and auditing

Logging In to the Self-Service Hub

This section walks you through the process of accessing and logging in to the Younium Self-Service Hub.

Prerequisites

Before you begin, ensure you have:

  • Valid credentials for your Younium tenant (Production & Sandbox)
  • User permission required in Younium; Self Service: View & Edit. (Settings>Admin> Roles> Self Service).

Step-by-Step Login Process

Step 1: Navigate to the Hub

Open your web browser and go to:

Step 2: Enter Your Credentials

If you are already signed in to Younium you will be automatically logged in, otherwise follow the steps below:

  1. Enter your username or email address in the first field
  2. Enter your password in the second field
  3. Click the Sign In button

Step 3: Select Legal Entity (If Applicable)

If you have access to multiple legal entities, you’ll be prompted to select which one you want to work with.

  1. Review the list of available legal entities
  2. Click on the legal entity you want to manage
  3. Click Continue or Select

Step 4: Access the Dashboard

After successful authentication, you’ll be redirected to the Self-Service Hub dashboard.


Dashboard Overview

The dashboard provides an overview of your Self Service configuration and activity:

Portal Status Card

Shows whether the hosted portal is enabled, along with the portal URL and quick access to settings.

Customer Users Card

Displays the total number of portal users across all customers, with a link to manage users.

Embedded Component Usage

Shows usage statistics for embedded components if configured.

Recent Activity

Lists the most recent activity log entries for quick auditing.


Connecting with Younium API Credentials

To enable data flow between the Self-Service Hub and your Younium instance, you need to configure API credentials.

Prerequisites

  • Access to your Younium Admin > Press the Avatar in top right corner> Privacy & security> Personal Tokens
  • Admin permissions in Younium to create API credentials

Step 1: Access API Settings

Navigate to Settings > Younium API in the left sidebar.

Step 2: Create API Credentials in Younium

  1. Log into your Younium application
  2. Navigate to Admin > API
  3. Click Create new credentials
  4. Copy the Client ID and Client Secret

Step 3: Configure in Self-Service Hub

  1. Paste the Client ID into the corresponding field
  2. Paste the Client Secret into the secure field
  3. Click Save Settings
  4. Click Test Connection to verify the configuration

Connection Status

  • Connected: Green indicator with last successful sync time
  • Disconnected: Red indicator with error details

Portal Settings

Configure your hosted customer portal appearance and features from the Portal Settings page.

Accessing Portal Settings

Navigate to Portal Settings in the left sidebar.

Configuration Options

Basic Settings

Setting Description
Portal Enabled Toggle to enable/disable the hosted portal
Portal Slug Custom URL identifier for your portal (e.g., acme for portal.younium.com/acme)
Portal Title Displayed title on the portal login and pages

Branding

Setting Description
Primary Color Main accent color for buttons and links
Logo URL URL to your company logo (recommended: PNG, 200x50px)
Favicon URL URL to your favicon
Custom CSS Additional CSS for advanced customization

Feature Toggles

Feature Description
Enable Invoices Allow customers to view and download invoices
Enable Account Allow customers to view and edit account information
Enable Subscriptions Allow customers to view and manage subscriptions
Enable User Management Allow customer admins to manage other portal users

Customer Users Management

Manage portal users for your customers, including inviting new users and configuring roles.

Accessing Customer Users

Navigate to Customer Users in the left sidebar.

Viewing Customers

The main view displays all Younium accounts with:

  • Account name
  • Account number
  • Number of portal users
  • Quick actions

Managing Users for a Customer

Click on a customer to view and manage their portal users.

Adding a Single User

  1. Click the + Add User button
  2. Enter the user’s email address
  3. Select a role (User or Admin)
  4. Toggle whether to send a welcome email
  5. Click Save

Mass User Invitation

For bulk user onboarding, use the Mass Invitation feature to import users from a CSV file.

Accessing Mass Invitation

  1. Click the Mass Invite button in the Customer Users page header
  2. The mass invitation modal will open

CSV Format Requirements

The CSV file must include the following columns: | Column | Description | Required | |——–|————-|———-| | CustomerIdentifier | Account number, account name, or Younium Customer ID | Yes | | Email | User’s email address | Yes | | Role | User role: User or Admin | Yes (defaults to User if omitted) |

Example CSV:

CustomerIdentifier,Email,Role
ACME-001,john@acme.com,Admin
ACME-001,jane@acme.com,User
BETA-002,support@beta.com,User

Import Options

Option Description
Has Header Row Check if your CSV includes column headers
Send Welcome Emails Send invitation emails to newly created users

Import Process

  1. Upload your CSV file (drag & drop or click to browse)
  2. Configure import options
  3. Click Start Import
  4. Monitor the progress bar as users are created
  5. Review the import results showing successful and failed rows

Handling Errors

The import will continue on errors and report:

  • Row number where the error occurred
  • Error reason (e.g., “Customer not found”, “User already exists”, “Invalid email”)
  • Customer identifier and email that failed

 

Subscription management

In the menu to the left there is an option called Subscriptions. The Subscriptions section controls which products are eligible for users of the self-service portals (both hosted and embedded components) to view and edit.

  1. Press the Add Product button.
  2. Search for the products in your product registry that you want to be visible to your customers. If they are not selected here, they will not be displayed to the end user — your customer.
  3. Once a product is included in the Subscription Configuration list, set the Product Options:
    1. Addable — the product can be added to an order.
    2. Enable or disable Charge Plans — if your products have multiple charge plans, you can define which ones should be included.
    3. Quantity-based products — for quantity-based products you can select:
      1. Allow Increase
      2. Allow Decrease
      3. Set a minimum quantity
      4. Set a maximum quantity

The current version of the self-service portal (both embedded components and the hosted portal) supports the following product types:

View: All product types 

Add & Change: Flat, quantity, and one-offs.

Once your products are enabled in the Subscriptions section, they will be visible to the end user.

 


Email Templates

Customize the transactional emails sent to portal users.

Accessing Email Templates

Navigate to Email Templates in the left sidebar.

Available Templates

Template Sent When
Welcome Email When a new portal user is created
Magic Link When a user requests to log in

Editing a Template

  1. Click on a template to edit
  2. Modify the subject line
  3. Edit the HTML body content
  4. Use merge tags for dynamic content:
    • {{UserEmail}} - User’s email address
    • {{AccountName}} - Customer account name
    • {{PortalUrl}} - Link to the portal
    • {{MagicLinkUrl}} - Login magic link
  5. Click Preview to test the template
  6. Click Save to apply changes

API Credentials for Embedded Components

Create and manage API credentials that allow your applications to use embedded self-service components.

Accessing API Credentials

Navigate to API Credentials in the left sidebar.

Creating New Credentials

  1. Click + Create Credentials
  2. Enter a descriptive name (e.g., “Marketing Website”)
  3. Configure allowed origins (domains that can use these credentials)
  4. Select the scopes (permissions) for these credentials
  5. Click Create

Available Scopes

Scope Allows
read:invoices View invoice list and download PDFs
read:account View account information
write:account Update account information
read:subscriptions View subscription list and details
write:subscriptions Request subscription changes

Credential Security

  • API Key: Public identifier, safe to include in client-side code
  • API Secret: Private key, displayed only once at creation
  • Allowed Origins: Restrict which domains can use these credentials

Testing Credentials

Use the Component Test Bed page to test your credentials with live data.


Embedded Components Overview

The Hub provides a JavaScript SDK for embedding self-service components in your web applications.

Accessing Embedded Components Documentation

Navigate to Embedded Components in the left sidebar for integration guides and code samples.

Available Components

Component Description
Invoice List Display customer invoices with search, pagination, and PDF download
Account Info Show and optionally edit account details
Subscription List Display subscriptions with quantity editing and add-on support

SDK Distribution

The SDK is available at:

<https://selfservice.younium.com/selfservice-sdk/{version}/younium-embedded-sdk.js>

Version Selection

The Hub supports multiple SDK versions. Navigate to the Components Test Bed to select and test different versions.

For detailed integration instructions, see the Embedded Self-Service Components documentation section.


Activity Log

Monitor all platform activities for security auditing and troubleshooting.

Accessing Activity Log

Navigate to Activity Log in the left sidebar.

Log Information

Each activity entry includes:

  • Timestamp - When the event occurred
  • Event Type - Category of the event
  • Description - Human-readable event description
  • User/Customer - Who triggered the event
  • Details - Additional context (expandable)

Filtering

Filter the log by:

  • Date range
  • Event type
  • Severity level
  • Search text

Exporting

Click Export to CSV to download the filtered log entries for external analysis.


Production vs Sandbox

Younium Self-Service operates on two separate environments:

Environment Hub URL Portal URL Purpose
Production selfservice.younium.com portal.younium.com Live customer data
Sandbox selfservice.younium.net portal.younium.net Testing and development

Key Differences

  • Sandbox data is separate from production
  • Sandbox can be refreshed independently
  • Test API integrations in sandbox before going live

Troubleshooting

Cannot Log In

  • Verify you have “Edit paywall” permission in Younium
  • Check that you’re using the correct environment (Production vs Sandbox)
  • Clear browser cache and cookies

API Connection Failed

  • Verify the Client ID and Secret are correct
  • Ensure the API credentials have not been revoked in Younium
  • Check network connectivity

Portal Not Accessible

  • Verify the portal is enabled in Portal Settings
  • Check that the portal slug is valid
  • Ensure DNS is properly configured for custom domains