Skip to main content
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:
SectionWhat Customers See
Plan OverviewCurrent subscription, pricing tiers, next charge date, cancel option
InvoicesInvoice history with status, amounts, and PDF downloads
Billing InformationCompany 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 to embed in your application. Endpoint: POST /portal/customer-session/customer-portal Request:
PropertyTypeRequiredDescription
accountIdstringIf no aliasThe Alguna account ID
accountAliasstringIf no IDExternal ID (e.g., your Salesforce ID or internal customer ID)
planOverviewSettingsobjectOptionalConfigure the Plan Overview section
invoiceListSettingsobjectOptionalConfigure the Invoices section
billingDetailsSettingsobjectOptionalConfigure the Billing Information section
Example Request: 
{
  "accountId": "acc_123456",
  "planOverviewSettings": {
    "showSection": true,
    "allowSubscriptionCancel": true
  },
  "invoiceListSettings": {
    "showSection": true
  },
  "billingDetailsSettings": {
    "showSection": true
  }
}
Response: 
{
  "sessionUrl": "https://yourcompany.alguna.app/portal/NWyfb389IdjI930..."
}
Redirect your customer to the sessionUrl to access their portal.

​
Configuring Portal Sections

​
Plan Overview Settings

Control what customers see in the Plan Overview section:
PropertyDefaultDescription
showSectiontrueShow or hide the entire Plan Overview section
allowSubscriptionCanceltrueAllow customers to cancel their subscription
The Plan Overview shows:
  • Subscription name and status
  • Estimated next charge amount
  • Next charge date
  • Pricing breakdown by product (tiers, quantities, fees)

​
Invoice List Settings

PropertyDefaultDescription
showSectiontrueShow or hide the Invoices section
The Invoices section displays:
  • Issue date and due date
  • Invoice amount
  • Status (Paid, Issued, Overdue)
  • Invoice ID
  • Open Invoice and Download PDF actions

​
Billing Details Settings

PropertyDefaultDescription
showSectiontrueShow or hide the Billing Information section
Customers can view and manage:
  • Company billing details
  • Payment methods
  • Auto-pay settings

​
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 at: 
https://yourcompany.alguna.app/portal/...
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:
  • Time-limited (expire after configured duration)
  • Tied to a specific customer account
  • Accessible via secure, single-use tokens
  • No password required

​
Best Practices

Brand Consistently

Match portal branding to your main application.

Control Cancellation

Use allowSubscriptionCancel: false for enterprise customers who should contact sales.

Hide Sections as Needed

Use showSection: false to simplify the portal for specific customers.

Use Account Alias

Pass your internal customer ID as accountAlias to avoid storing 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.