Skip to main content

​
Overview

Hyperline offers a customer portal where your customers can get access to their live subscription, payment methods, billing information and invoices. Our objective is to ensure a transparent and well-organized billing summary to offer to your own customers.
As well as displaying information correctly, this portal offers a number of action options for your customers:

​
Portal language

The language will be displayed following these rules:
  • If the customer’s browser language is part of our 9 supported languages (English, French, German, Italian, Spanish, Polish, Portuguese and Dutch), it will be displayed in the language.
  • If it is not part of the supported languages, we will default on the customer language selected on Hyperline customer information. By default, this language is inferred based on the customer’s country.

​
View subscription details

Customers can access the full details of their subscription by clicking on ‘Subscription details’ on the portal.
This sub-page will display the content of the next invoice that will be billed, as well as the detailed price structure of every product.

​
Change payment method

To do that, they just have to click on the trash button next to their payment and add the new payment method they want to use.

​
Top-up wallet

You can make your customers autonomous by offering them to top-up their wallet in the portal. For this, make sure you enable the option on the wallet settings first. Clicking on Top-up wallet on this screen will trigger an immediate payment from the registered credit card and credit the wallets instantly.

​
Edit billing information

To make changes, they simply need to click on the Edit button. This grants them the ability to update and modify their billing details as needed, ensuring accuracy and up-to-date information for a seamless payment process.
This capability can be controlled in Settings > Hosted pages. See the Billing details update section below for more details.

​
Download invoices

All invoices are listed and can be open to their dedicated invoice page.
Customer can download their invoice PDF using the ‘Download’ button on the top-right corner.

​
How to access the customer portal

To view the portal for a specific customer: go to the customer page, select the customer you want to view then click on the ‘Portal’ button.
You can easily provide your customers with this unique portal link. Each customer portal link is individually generated and secured through a unique ID.

​
Customize the portal

​
Colors & brand identity

The portal adopts the primary brand color and icon that have been configured in the ‘Settings’ section under the ‘General’ tab of Hyperline. This uses the same codes as those displayed on the invoice sent to your customers. This feature enables you to personalize your customer portal with the distinct colors and branding of your company

​
Set a custom domain

In order to personalize further the experience for your customers, you can configure a custom domain for the hosted portal and checkout pages. You can set it in your settings, and to enable it you need to add a CNAME record pointing to cname.hyperline.co on your DNS provider. For example: you want to set your custom domain to billing.alpeak.com in Hyperline, and add the related CNAME record on your DNS provider, we will provide you portal and checkout URLs with the form: 
https://billing.alpeak.com/portal/:customerId
https://billing.alpeak.com/checkout/:sessionId
We will automatically manage the related HTTPS SSL certificate.

​
Customer actions

You can control what actions customers can perform on hosted pages through Settings > Hosted pages under the Customer actions section:

​
Billing details update

You can control whether customers can update their billing details (billing address, billing email, tax ID, and invoice emails) on hosted pages through Settings > Hosted pages under the Customer actions section. Toggle Allow billing details update to enable or disable this capability. When enabled, customers will be able to edit their billing information through the customer portal, checkout, and quote pages.

​
Customer typology selection

By default, hosted pages (customer portal, checkout, and quote pages) allow customers to select between B2C (person) and B2B (corporate) typologies when updating their billing information. You can disable this typology selection in Settings > Hosted pages under the Customer actions section. When disabled, customers will not be able to change their typology on hosted pages, and the form will use their existing typology setting.

​
Portal authentication

You can require customers to authenticate before accessing the customer portal through Settings > Hosted pages under the Authentication section. When enabled, customers must verify their identity via a magic link sent to their email address before they can view their portal.

​
How it works

When authentication is enabled:
  1. Customers visiting the portal URL will see a login screen
  2. They enter their email address (must match their billing email or invoice emails)
  3. A magic link is sent to their email
  4. Clicking the magic link grants access to the portal for the configured token lifetime
Portal authentication adds an extra layer of security by ensuring only authorized users can access customer billing information. This is particularly useful for B2B customers where multiple people might have access to shared links.
You can programmatically request magic links for your customers using the API: 
curl -X POST https://api.hyperline.co/portal-v2/auth/request-link \
  -H "Content-Type: application/json" \
  -d '{
    "email": "customer@example.com",
    "clientId": "cli_your_client_id"
  }'
This endpoint will send a magic link email to the customer if their email matches a customer record. For security reasons, it always returns success even if the email is not found.
Use this API endpoint to integrate portal access into your own application flows, such as sending portal links from your customer support system or embedding portal access in your product.

​
Authentication vs. token expiration

Portal authentication and token expiration work together to control access:
  • Authentication disabled, no token expiration: Portal links work indefinitely without requiring login (default behavior)
  • Authentication disabled, token expiration enabled: Portal links expire after the configured time, but customers can access the portal again by visiting the link (a new token is automatically generated)
  • Authentication enabled, no token expiration: Customers must authenticate once via magic link, then can access the portal indefinitely
  • Authentication enabled, token expiration enabled: Customers must authenticate via magic link, and their session expires after the configured time
When authentication is enabled, customers without a valid token will always see the login screen, even if they have a portal link. Make sure to communicate this change to your customers.

​
Token expiration

By default, hosted page URLs (customer portal, checkout, and quote pages) contain authentication tokens that never expire. You can configure a token expiration time in Settings > Hosted pages to automatically expire tokens after a specified duration (in minutes). When token expiration is enabled:
  • Tokens are included in all hosted page URLs (both Hyperline-hosted and custom domain URLs)
  • After the expiration time, customers will need a new link to access the page
  • This applies to portal links, checkout session links, and quote links
Token expiration enhances security by limiting how long a shared link remains valid. This is particularly useful if you share links via email or other channels where they might be forwarded.

​
Set a redirect button

You can configure a back button in the hosted pages settings.
And it will look like this in the portal

​
Display personalization

You can add this query parameter to your portal URL to hide the sidebar &hideSidebar=true. It will look like this:
It works both for custom domain and hyperline hosted pages.

​
Customer actions

You can control which actions customers can perform on hosted pages (customer portal, checkout, and quote pages) by configuring settings in Settings > Hosted pages under the Customer actions section.

​
Billing details update

By default, customers can edit their billing details (name, address, tax ID, etc.) on hosted pages by clicking the Edit button. You can control this capability in Settings > Hosted pages under the Customer actions section:
  • Allow billing details update (enabled by default): When enabled, customers can click the Edit button to modify their billing information on hosted pages.
  • When disabled, the Edit button will not appear, and customers will not be able to modify their billing information through hosted pages.

​
Customer typology selection

By default, hosted pages allow customers to select between B2C (person) and B2B (corporate) typologies when updating their billing information. You can disable this typology selection in Settings > Hosted pages under the Customer actions section. When disabled, customers will not be able to change their typology on hosted pages, and the form will use their existing typology setting.

​
Customer authentication

You can require customers to authenticate before accessing the customer portal. When enabled, customers must verify their email address using a secure verification link before they can view their billing information. To enable it, go to Settings > Hosted pages and toggle Customer authentication under the Security section. When enabled, the portal access flow changes: When authentication is enabled:
  • Customers visiting the portal will be prompted to enter their email address
  • A verification link will be sent to authorized email addresses
  • The verification link provides secure access to the customer portal
  • This adds an extra layer of security to protect sensitive billing information
Customer authentication is independent of link expiration. You can use both features together for enhanced security.
You can configure an expiration time for hosted page links in Settings > Hosted pages. When set, links to the customer portal, checkout pages, and quote pages will automatically expire after the specified duration. To configure link expiration:
  1. Go to Settings > Hosted pages
  2. Find the Link expiration delay field under the Security section
  3. Enter the number of minutes after which links should expire
  4. Leave the field blank if you don’t want links to expire
When a link expires, customers will no longer be able to access the hosted page using that link. This security feature is useful for controlling access to sensitive billing information and ensuring that shared links have a limited lifetime.

​
Embed the customer portal in an iframe

You can embed the Hyperline customer portal inside your application using an <iframe>. If your site uses a strict Content Security Policy (CSP), you must explicitly allow our domains 
<meta
  http-equiv="Content-Security-Policy"
  content="
    default-src 'self';
    frame-src 'self' https://app.hyperline.co https://api.hyperline.co https://internal.hyperline.co;
    connect-src 'self' https://api.hyperline.co;
    img-src 'self' data:;
    script-src 'self';
    style-src 'self' 'unsafe-inline';
    font-src 'self' https: data:;
    base-uri 'self';
    object-src 'none';
    upgrade-insecure-requests;
  ">
Add the following origins to your CSP so the iframe can load and downloads work: Production Sandbox If you’re using a custom domain for hosted pages, also include that domain wherever you allow app.hyperline.co.