Chargebee Self-Serve Portal

Using the Chargebee Self-Serve Portal, customers can modify subscriptions (add, edit, pause, resume, cancel, or reactivate), download previous invoices, manage payment methods, manage addresses, and pay unpaid invoices.

The Self-Serve Portal displays as a modal popup or as a standalone page. Do not embed hosted portal URLs in your own iframe elements. Use Chargebee.js to open the portal as a modal, or redirect customers to the standalone portal page.

Enable the Self-Serve Portal

To enable the Self-Serve Portal, click Settings > Configure Chargebee > Checkout and Self-Serve Portal > Portal > Enable.

Configure Self-Serve Portal

General settings

These settings control what customers can do in the Self-Serve Portal. To configure them, click Settings > Configure Chargebee > Checkout and Self-Serve Portal > Portal.

• Customers can access the self-serve portal: This setting provides two options for customer access to the Self-Serve Portal:

  • Via Single Sign On API: Recommended if you manage user authentication in your application. After users sign in to your application, create portal sessions for them dynamically. This approach enhances the customer experience by eliminating the need for users to sign in again after logging into your application or website.

  • Via Chargebee Login: This option uses the default portal that Chargebee provides. Customers must sign in by entering their primary email address. They receive a one-time password (OTP) by email. After the first sign-in, they are prompted to create a password for later access.

    Email addresses that you add under additional contacts, including addresses marked for billing or account email, cannot be used to sign in to the portal.

• Allow customers to download invoices: Enable this option to let customers download previous invoices.

• Allow customers to change subscription: Enable this option to let customers change their subscription using the Self-Serve Portal. You can also control the behavior of the change subscription action in the Self-Serve Portal using the following sub-settings:

Recommended addons mapped to a plan are shown with a "recommended" tag.

The following image shows a subscription change in the Self-Serve Portal:

The following image shows a customer adding an addon in the Self-Serve Portal:

• Allow customers to cancel subscription: Enable to let customers cancel their subscription using the Self-Serve Portal. When enabled, control how cancellation works with the following sub-settings:

• When the subscription will get cancelled: Immediately, At the end of the term, or Allow customers to choose.

• When you select Allow customers to choose, you can also specify when customers can cancel their subscriptions: Immediately, At the end of term, or On a specific date. With On a specific date, customers can schedule the cancellation for a particular date within the subscription period.

  

• Allow customers to provide feedback during cancellation: Enable to collect feedback from customers while cancelling.

• Allow customers to reactivate cancelled subscriptions: Enable to let customers reactivate their subscription. For details, see Reactivate a subscription.

• Allow customers to remove scheduled changes: Enable to let customers cancel any changes they have scheduled, such as a subscription pause.

• Allow customers to remove scheduled cancellation: Enable to let customers remove any subscription cancellations they have scheduled.

• Allow customers to remove their primary payment method: Enable to let customers remove their primary payment method.

• Allow customers to pause subscriptions: Enable to let customers pause their subscriptions from the Self-Serve Portal. For this setting to work, pause subscription must be enabled for your site.

When this setting is turned on, two sub-settings appear:

When Allow customers to choose the duration is selected, configure the Maximum no. of days customers can pause subscriptions setting. Clicking the value opens a panel with two configurations:

• Pause Period: Set the upper bound (in days) for how long a customer can pause a subscription. Any interval you offer must be within this limit.
• Pause Intervals: Choose the duration options the customer sees in the Self-Serve Portal when pausing a subscription. Click Manage to open the Subscription pause period modal:
  • The available intervals are displayed. Clear the checkbox for any interval you don't want to offer.
  • Click Add another option to add a custom interval (in days), then click Add. The custom interval must not exceed the Pause Period maximum.
  • Click Apply to save your selections.

• Allow customers to resume paused subscriptions: Enable to let customers resume a paused subscription from the Self-Serve Portal. When enabled, the Subscription Details page in the portal displays a Your subscription is currently paused. banner with a Resume now action on paused subscriptions. Resumption is always immediate—scheduling a resumption on a specific date is not supported in the portal. To schedule a resumption on a specific date/time, use the Chargebee UI or the Resume Subscription API.

  This setting is independent of Allow customers to pause subscriptions. You can let customers resume their subscriptions even if you do not allow them to pause subscriptions from the portal (for example, if pauses are only initiated by your support team).

3D Secure support for Self-Serve Portal

The Self-Serve Portal supports 3D Secure transactions. Complete the SCA checklist to handle 3D Secure payments through the Self-Serve Portal.

Portal actions such as Update Payment Method and Add Payment Method involve no payment, so Chargebee triggers a 3D Secure authorization for a minimal amount during those operations. The authorized amount is voided automatically.

If an action such as Change Subscription or Resume Subscription involves an immediate charge, Chargebee triggers 3D Secure verification for that charge.

Access the Self-Serve Portal

If access to the Self-Serve Portal is enabled Via Chargebee Login, customers can access the portal using the following URL format: https://{your-Chargebee-subdomain}.chargebeeportal.com.

For example, if your Chargebee site URL is https://acme-test.chargebee.com, the Self-Serve Portal URL is https://acme-test.chargebeeportal.com.

To locate this URL in Chargebee Billing:

1. Go to Settings > Configure Chargebee > Checkout and Self-Serve Portal.
2. Select INTEGRATE WITH CHARGEBEE from the top navigation bar.
3. In the modal that appears, scroll to the bottom to find Portal Link.

Preview the Self-Serve Portal

To preview the Self-Serve Portal, click Preview Checkout/Portal on the Checkout and Self-Serve Portal settings page.

Testing the Self-Serve Portal flow on the test site

To test the Self-Serve Portal flow for a customer record on the test site, follow these steps:

1. Go to Configuration and click Preview Checkout/Portal.
2. Select a test email address from the dropdown in the top-right corner.
3. Use 123456 as the password.
4. Proceed to test the flow.

Disable the Self-Serve Portal

To disable the Self-Serve Portal, click Disable in the Portal settings. After you disable it, customers can no longer access the portal.