Customer Portal

Enable self-service account management for your customers

The Customer Portal provides a self-service interface where your customers can view their subscription, invoices, and billing information. Reduce support burden while giving customers control over their accounts.

---

Portal Sections

The Customer Portal has three main sections:

Section	What Customers See
Plan Overview	Current subscription, pricing tiers, next charge date, cancel option
Invoices	Invoice history with status, amounts, and PDF downloads
Billing Information	Company details, payment methods, auto-pay settings

---

Sending Portal Access

Via Dashboard

1. Navigate to Customers → select customer
2. Click Send Portal Link
3. Customer receives email with secure link
4. Link expires after configured time

Via API

Create a portal session programmatically and redirect the customer to the URL it returns.

Endpoint: POST /customer-portal-sessions

Property	Type	Required	Description
customer_id	string	If no alias	The Alguna customer ID
customer_alias	string	If no ID	Your external ID for the customer, such as a CRM record ID
plan_overview_settings	object	Optional	Configure the Plan Overview section
invoice_list_settings	object	Optional	Configure the Invoices section
billing_details_settings	object	Optional	Configure the Billing Information section

Omit a settings object to use your organization’s defaults.

curl -X POST https://api.alguna.io/customer-portal-sessions \
  -H "Authorization: Bearer $ALGUNA_API_KEY" \
  -H "Alguna-Version: 2026-04-01" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "cust_abc123",
    "plan_overview_settings": {
      "show_section": true,
      "allow_subscription_cancel": true
    },
    "invoice_list_settings": {
      "show_section": true
    },
    "billing_details_settings": {
      "show_section": true
    }
  }'

Response

{
  "id": "a8B3kLmQ",
  "url": "https://portal.alguna.io/hs/abc123",
  "customer_id": "cust_abc123",
  "expires_at": "2026-04-01T11:00:00Z",
  "created_at": "2026-04-01T10:00:00Z"
}

Redirect the customer to url. Sessions are single-use and short-lived, so create one at the moment the customer clicks through rather than storing the link.

---

Configuring Portal Sections

Each setting falls back to your organization’s default when omitted.

Plan Overview Settings

Property	Description
show_section	Show or hide the entire Plan Overview section
allow_subscription_cancel	Let the customer cancel their subscription
allow_self_serve_change	Let the customer change their plan without contacting you

The Plan Overview shows the subscription name and status, the estimated next charge and its date, and a pricing breakdown by product.

Invoice List Settings

Property	Description
show_section	Show or hide the Invoices section

The Invoices section lists issue and due dates, amounts, status, and actions to open an invoice or download its PDF.

Billing Details Settings

Property	Description
show_section	Show or hide the Billing Information section
allow_account_edit	Let the customer edit their account details
allow_payment_method_edit	Let the customer add or change a payment method
allow_autopay_edit	Let the customer turn autopay on or off

---

Branding

The portal displays your company branding:

1. Navigate to Settings → Branding
2. Upload your logo
3. Set primary colors
4. The portal will use your branding automatically

---

Custom Domain

By default the portal is served from an Alguna-hosted URL, returned as url on the session.

You can use your own domain (e.g., billing.yourcompany.com) for a seamless customer experience. See Custom Domains for setup instructions.

---

Security

Portal sessions are:

• Short-lived: the session carries an expires_at, after which the customer needs a new one
• Tied to a specific customer
• Single-use per token
• Passwordless: possession of the link is the credential, so treat it as a secret and generate it on demand

---

Best Practices

Brand Consistently

Match portal branding to your main application.

Control Cancellation

Set allow_subscription_cancel to false for enterprise customers who should talk to sales.

Hide Sections as Needed

Set show_section to false to simplify the portal for specific customers.

Use a Customer Alias

Pass your own customer ID as customer_alias so you don’t have to store Alguna IDs.

---

API Reference

Create Portal Session

Generate portal links via API.

Webhooks

Track subscription and invoice events.

---

Next Steps

Hosted Checkout

Set up hosted checkout pages.

Custom Domains

Use your own domain for hosted pages.