> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer portal

> Unlock a branded portal for customers to view past invoices, usage and credit balances

## Overview

Sequence provides a branded customer portal including a history of invoices, usage and credit transactions. Make it easy for your customers to view outstanding, overdue and paid invoices. Provide a transparent billing experience and provide your customers with a visual overview of usage events they're billed for, grouped by billing period.

![Customer Portal overview](https://mintcdn.com/sequence/x1KLJXMII5R5d7eg/images/product/customers/customers_5.png?fit=max\&auto=format\&n=x1KLJXMII5R5d7eg\&q=85\&s=fe5e4c0223d216c31a44c5acb4886dd8)

### Portal settings

Admins can manage the portal in **Settings → Customer Portal**. Learn more about [roles and permissions](https://docs.sequencehq.com/users/roles-permissions.md).

| Setting | What it does |
| - | - |
| **Enable end-customer portal** | Gives your customers access to the portal, and adds a portal link to your invoice emails. |
| **Show usage in end-customer portal** | Adds a usage tab so customers can follow their usage as it happens. |
| **Display a link back to your application** | Adds a link from the portal back to your app, using the application URL you enter. |
| **Require authentication to access the portal** | Asks visitors to log in with their email before viewing the portal. See [Portal authentication](#portal-authentication). |

### Accessing the customer portal

To view the portal for a specific customer, navigate to a customer from the Sequence dashboard and copy the link. You can also view an invoice in the customer portal directly from the invoice view in the dashboard.

![Customer Portal link](https://mintcdn.com/sequence/x1KLJXMII5R5d7eg/images/product/customers/customers_7.png?fit=max\&auto=format\&n=x1KLJXMII5R5d7eg\&q=85\&s=18d4c4a836463d065de5bd500a6d6805)

#### Portal authentication

When **Require authentication to access the portal** is on, anyone opening a portal link is asked for their email address and sent a login link.

![Portal login prompt via email](https://mintcdn.com/sequence/WzjQN-ebnq5XTbCS/images/product/customers/customers_17.png?fit=max\&auto=format\&n=WzjQN-ebnq5XTbCS\&q=85\&s=8660053a28eca26feebfd9491f443120)

> [!NOTE]
>
> With authentication on, only contacts associated with the customer and members of your Sequence account can access the portal.

> [!TIP]
>
> Authentication is optional. Turn it on if you'd like portal access limited to each customer's contacts. Without it, anyone with the portal link can view it.

### Sharing and embedding a link

To **share** the portal, simply share the portal link with your customer. Customer portal links are obscured and unique per customer (via the unique id of a customer). This approach is also used by payment and accounting providers like Stripe and Xero.

Example customer portal link: `https://portal.sequencehq.com/customers/{unique_id}`

To embed a link to the customer portal in your app, use the Sequence API [Customers endpoint](https://docs.sequencehq.com/reference/latest/customer/list-customers.md) and insert the relevant customer id.

## Invoice history

The Invoices tab includes an overview of outstanding, overdue and paid invoices. Enable the Stripe connector to collect payments directly from the customer portal.

> [!NOTE]
>
> Only `Sent` invoices are displayed in the customer portal.

Invoice email notifications sent to your customers also include a link to view the invoice in the customer portal.

![Customer Portal invoice tabs](https://mintcdn.com/sequence/x1KLJXMII5R5d7eg/images/product/customers/customers_8.png?fit=max\&auto=format\&n=x1KLJXMII5R5d7eg\&q=85\&s=b578e610dde05dfbf63a2544aaa33c6e)

![Customer Portal invoice](https://mintcdn.com/sequence/x1KLJXMII5R5d7eg/images/product/customers/customers_9.png?fit=max\&auto=format\&n=x1KLJXMII5R5d7eg\&q=85\&s=d5e53a2624711ddeb506c629d25e2b3e)

## Usage overview

The usage tab provides a real-time overview of usage events per billing period. If your pricing uses multiple metrics, each metric is displayed separately. Usage is shown for each active billing schedule.

> [!NOTE]
>
> Turn on **Show usage in end-customer portal** to display the usage tab.

![Customer Portal link](https://mintcdn.com/sequence/mG-N6nCfQdxFJGM7/images/product/customers/customers_10.png?fit=max\&auto=format\&n=mG-N6nCfQdxFJGM7\&q=85\&s=3de85540ce3e7364d9a81c76781b3f77)

## Credit overview

The credits tab shows credit balances and transactions over time. Learn more about [credit grants](https://docs.sequencehq.com/credits/overview.md).

> [!NOTE]
>
> The credits tab is only visible if you have granted credits to a customer.

In the below example, `AcmeLabs` have granted their customer `Globex` 250 account verification credits on July 20. `Globex` have verified 6 unique accounts in August, reflecting as a pending debit of 6 credits. Once the August invoice is finalized, the credits will be deducted from `Globex` balance.

![Customer Portal credit overview](https://mintcdn.com/sequence/mG-N6nCfQdxFJGM7/images/product/customers/customers_11.png?fit=max\&auto=format\&n=mG-N6nCfQdxFJGM7\&q=85\&s=359b2aa132ae0fa7383d6e1f5fb573e5)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.