Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

​
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 8 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. You can generate a portal link for a specific customer in two ways: The returned link embeds an authentication token. It is valid for the duration set in Link expiration delay, or indefinitely if the delay is empty. After expiry, behavior depends on whether Require customer authentication is enabled — see Authentication vs. link expiration.

​
Portal authentication

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

​
How it works

Portal links contain an authentication token. Link expiration delay controls how long that token is valid; Require customer authentication controls what happens when no valid token is present. When authentication is required and a customer opens the portal without a valid token (first visit, expired token, or direct URL):
  1. The portal shows a login screen.
  2. The customer enters an email matching their billing email or invoice emails.
  3. A magic link is sent to that email.
  4. Clicking the magic link grants access — indefinitely if no link expiration is set, otherwise for the configured window.
Portal authentication adds an extra layer of security by ensuring only authorized users can access customer billing information. Useful for B2B customers where multiple people might share portal links.
Portal authentication and Link expiration delay combine to control access:
  • Auth off, no expiration: portal links work indefinitely (default).
  • Auth off, expiration set: tokens expire after the configured delay; revisiting the URL automatically issues a new token, no login required.
  • Auth on, no expiration: customers without a valid token are sent to the login screen. After authenticating via magic link, the issued token never expires (one-time auth, permanent access).
  • Auth on, expiration set: links work for the configured window. After expiry, customers must re-authenticate via magic link to obtain a new token.
When authentication is required, every visit without a valid token redirects to the login screen. Communicate this to your customers if you change the setting.
By default, hosted page URLs (customer portal, checkout, and quote pages) contain authentication tokens that never expire. You can configure an expiration in Settings > Hosted pages > Domain > Link expiration delay (in minutes). When set:
  • Tokens are included in all hosted page URLs (both Hyperline-hosted and custom domain URLs).
  • After the delay, customers need a new link or must re-authenticate to access the page.
  • Applies to portal links, checkout session links, and quote links.
Link expiration enhances security by limiting how long a shared link remains valid. Useful when links are sent 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.

​
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.