Docs
Using the Chargebee Self-Serve Portal, customers can modify subscriptions (add, edit, pause, resume, cancel or reactivate), download previous invoices, manage payment methods, and manage addresses.
To enable Self-Serve Portal, click Settings > Configure Chargebee > Checkout and Self Serve Portal > Portal > Enable.
You can configure to display specific settings for your customers to access using the Self-Serve Portal. To set up the same, click Settings > Configure Chargebee > Checkout and Self Serve Portal > Portal.
Customers can access the self-serve portal: This setting provides two options for enabling 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 provided by Chargebee. Users log in by entering their email address, after which they receive a one-time password (OTP) via email. Upon their first login, users are prompted to set up a password for future access.
The invoice might be hidden in the customer portal if any of the customers in the hierarchy are unlinked.
Setting |
Functionality |
Statuses in which subscriptions can be changed |
Select the subscription states for which change subscription is allowed - active, non-renewing and trial. |
| Apply subscription changes | Select when the changes made should be effective - immediately or at the end of term. |
| Allow customers to change plans | Enable to allow your customers to change their plan. Proration applies as per site setting. |
| Allow customers to change plan quantity | |
| Allow customers to add addons | |
| Allow customers to remove addons | |
| Allow customers to change addon quantity | |
| Allow customers to add/remove coupons |
Sample of change subscription in Self-Serve Portal:
Sample of adding an addon in Self-Serve Portal:
For addons and charges to appear in the Self-Serve Portal, you must enable the option Display in Self-Serve Portal while creating addons and charges.
If not enabled already, you can use the Edit action to enable it.
To enable it, click Product catalog > Addon (or) Charge and select the addon or charge which needs to be displayed in the portal. Under the Customer-Facing Info section, enable Display in Self-Serve Portal.
Allow customers to cancel subscription: Enable to allow customers to cancel their subscription using the Self-Serve Portal. On enabling, you can choose to control the behavior of cancel subscription using the following sub-settings:
When the subscription will get cancelled - Immediately/At the end of the term/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/On a specific date. By choosing "On a specific date", your customers can schedule the cancellation to happen on 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 allow customers to reactivate their subscription. Learn more.
Allow customers to remove scheduled changes: Enable to allow customers to cancel any changes they have scheduled, such as a subscription pause.
Allow customers to remove scheduled cancellation: Enable to allow your customers to remove any subscription cancellations they have scheduled.
Allow customers to remove their primary payment method: Enable to allow customers to remove their primary payment method.
Allow customers to pause subscriptions: Enable to allow your customers to pause their subscriptions. Do note that for this to work, you must have enabled pause subscription for your site. Learn more.
Allow customers to choose duration has two subsettings:
Here's a screenshot of the manage pause interval window:
Take a look at our detailed doc on Checkout and Portal Advanced Settings to know more.
Chargebee's In-app Customer Portal supports 3DS transactions. Complete our SCA checklist, for handling seamless 3DS payments via Chargebee's Customer Portal.
Since no payment is involved during portal actions such as Update Payment Method and Add Payment Method , we will trigger a minimum amount of 3DS authorization during those operations. The amount deducted for authorization would be voided automatically.
If there is any immediate charge involved during actions such as Change Subscription and Resume Subscription, 3DS verification will be triggered accordingly.
Provided the 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 customer portal URL will be https://acme-test.chargebeeportal.com.
To locate this URL in Chargebee Billing:
To preview the Self-Serve Portal, click Preview Checkout/Portal in the Checkout and Self Serve Portal settings page.
The preview checkout in the live site uses the configuration from the test site's checkout.
Click the Disable button under the Portal settings to disable it. Disabling the Self-Serve Portal renders it inaccessible to your customers.
Articles & FAQ