New in Chargebee: Explore Reveal and understand your payment performance end-to-end.Try Now
Docschargebeedocs
HomeBillingPaymentsRevRecGrowthReveal
Support

Product Updates

  • Release Notes

Getting Started

  • Overview
  • Chargebee Billing Data Centers
  • Object Relationship Model
  • Understanding Sites
  • Developer Resources
  • Chargebee Tech Glossary
  • Articles and FAQ

Implementing Chargebee

  • Implementation Guide
  • Go-live Checklist
  • Articles and FAQ

AI in Chargebee

  • Chargebee Agents
  • Chargebee Copilot
  • Chargebee MCP Server (Model context protocol)

Product Catalog

  • Product Catalog Overview
  • Coupons
  • Articles and FAQ

Subscriptions

  • Working with Subscriptions
  • Billing
  • Orders
  • Articles and FAQ

Customers

  • Managing Customers
  • Account Hierarchy
  • Email Notifications
  • Branding
  • Configure Multiple Languages
  • Articles and FAQ

Invoices, Credit Notes and Quotes

  • Invoices
  • Credit Notes
  • Quotes [Legacy]
  • Transactions
  • Articles and FAQ

Taxes

  • Overview
  • Configuring Taxes
  • Country-specific Taxes
  • Articles and FAQ

Hosted Capabilities

  • Overview
  • Hosted Checkout
  • Hosted Self-Serve Portal
  • Hosted Pages Features
  • Additional Hosted Pages
  • Payment Components
  • Managing payments with ChargebeeJS
  • Mobile-Optimized Hosted Pages
  • Articles and FAQ

Site Configuration

  • Users & Roles
  • Custom Fields & Metadata
  • Mandatory Fields
  • File Attachments & Comments
  • Advanced Filter Options
  • Multicurrency Pricing
  • Multi-decimal Support
  • Configuring Reason Codes
  • Events and Webhooks
  • API Keys
  • Time Zone
  • Time Machine
  • Transfer Configurations
  • Articles and FAQ

Reports and Analytics

  • RevenueStory
    • Reports Explorer
    • Custom Fields in RevenueStory
    • Report Builder
      • Working with Reports
      • Data Sources
        • Coupons
        • Credit Notes
        • Customers
        • Customer Balance
        • Invoices
        • Orders
        • Payments
        • Products
        • Refunds
        • Subscriptions
        • Multientity
        • Product Family
        • Subscription Contract Terms
        • Dunning Details
        • Invoice Transactions
        • Invoice Line Items
        • Invoice Addresses
        • Invoice Discounts
        • Credit Note Line Items
        • Monthly Subscription History
        • Yearly Subscription History
        • Applied Credits
        • Monthly Component History
        • Yearly Component History
        • Order Line items
        • Payment Sources
        • Subscription Discounts
        • Subscription Addons
        • Subscription Shipping Addresses
      • Sample Reports
    • Monthly Recurring Revenue (MRR)
    • Metric Description
  • Home Dashboard
  • Frequently Asked Questions
  • FAQs for Classic Reports Sunset
  • Articles and FAQ

Integrations

  • Sales
  • Customer Support and Success
  • Finance
  • Tax
  • Marketing
  • Stitch
  • Collaboration
  • Contract Management
  • Order Management
  • Mobile Subscriptions (Legacy)
  • Other Integrations
  • Articles and FAQ

Data Privacy & Security

  • Two Factor Authentication
  • SAML Single Sign-On
  • System for Cross-Domain Identity Management (SCIM)
  • EU-GDPR
  • Consent Management
  • Personal Data Management
  • Compliance Certificates
  • HIPAA Guidelines
  • PCI Recommendations and Integration Types
  • Articles and FAQ

Data Operations

  • Bulk Operations
  • Migration
  • Articles and FAQ
  1. Billing
  3. Customers
  4. Customer Portal Api
  1. Billing
  3. Customers
  4. Customer Portal Api

Customer Portal using Chargebee's API

Chargebee provides several options for your customers to manage their accounts. In addition to a pre-built customer portal, Chargebee offers the following self-service portal options:

  1. Chargebee's pre-built Hosted Customer Portal with built-in authentication
  2. Chargebee's Hosted Customer Portal with your website's authentication

1. Chargebee's Customer Portal with in-built Authentication

Chargebee provides a pre-built customer portal with built-in authentication. You can get started with the default portal right away and make a few tweaks to suit your business needs. This option is discussed in detail here.

2. Chargebee's Customer Portal with your Website's Authentication

If your customers already log in to your website to access your application, you likely don't want them to sign in again to access Chargebee's customer portal.

In these cases, you can redirect customers directly to Chargebee's portal using the API. This is referred to as SSO (Single Sign-On).

Follow these steps to support portal access via SSO:

  1. On the Chargebee UI, under Settings > Configure Chargebee > Checkout & Self-Serve Portal > Customers can access the self-serve portal choose Via Single Sign On API.
  2. Include a link/button on your site that leads customers to the portal for managing their account.
  3. When customers click the link, handle the link request at your server's end and create a portal session for the customer using Chargebee's "Create a portal session" API.
  4. Redirect the user to the access URL present in the "Portal Session" resource returned by the API call that was made in the previous step.

Note

  • The access URL will be valid for only an hour from the time it was created.
  • Once accessed, the session is valid until the user logs out from the portal or the Logout API is invoked from your application for that particular session.
  • The Access URL cannot be reused. So create a new Portal session each time you need to provide access to the portal.

Was this article helpful?