Chargebee provides a seamless and efficient self-serve portal for your customers to manage their account information. Your customers can edit, pause, cancel subscriptions, download previous invoices, manage payment methods and their shipping/billing address using this self serve portal.
This documentation is applicable only for users who are using Chargebee Checkout in their Live Site. If you are using Checkout via hosted pages, refer to this help page.
Users signing up to Chargebee after February 06, 2018 will have Chargebee Checkout enabled by default.
For the self serve portal to be visible for the customers, it must be enabled first.
As a merchant, you can choose what your customers must see in the self serve portal. You can access the portal settings by selecting Settings > Configure Chargebee > Checkout and Self Serve Portal > Portal
Given below are the options that can be configured in Chargebee's Self-Serve portal:
Customers can access the self-serve portal: There are two options by which customers can access the self-serve portal.
Via Chargebee Login: This is the default portal built by Chargebee. Your customers can login to their portal by entering the email ID and a one time password sent via email.
Using single sign on API: Integrating portal via API allows you to reuse your app's authentication to open the self-serve portal. This improves your end user experience as they do not need to sign in again. Refer to this help document to learn more.
Allow customers to download invoices: Selecting this option allows customers to download previous invoices.
Allow customers to change subscription: When you enable this option, customers can directly change their subscription from their self serve portal. Learn about ‘Change Subscription'. On enabling this option you can choose to control the behaviour of the change. You can do the following:
Setting |
Functionality |
Statuses in which subscriptions can be changed |
Sets the subscription states in which customers can change their subscription - Active, non-renewing and trial. |
| Apply subscription changes | Sets when the subscription changes should be effective- immediately or at the end of term. |
| Allow customers to change plans | Provides the option for your customers to change their plan. Proration will apply as per site setting. |
| Allow customers to change plan quantity | Provides the option for your customers to change plan quantity. |
| Allow customers to add addons | Allows your customers to add addons to the existing plan. You can allow non-recurring addons, recurring addons or both. The Add Addons option is found under Edit Subscription in the portal. Recommended addons mapped to a plan are shown with a "recommended" tag. |
| Allow customers to remove addons | Provides the option for your customers to remove the addons added to their subscription. Option available for non-recurring or recurring addons or both. |
| Allow customers to change addon quantity | Provides the option for your customers to change the quantities of addons added to their subscription. Option available for non-recurring or recurring addons or both. |
| Allow customers to add/remove coupons | Provides the option for your customers to add coupons or remove added coupons. |
Allow customers to cancel subscription: Enabling this option will allow customers to cancel their subscription from the self serve portal. On enabling this option, you must choose:
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", you can allow your customers to schedule the subscription cancellation for a particular date within the subscription period.
Whether customers can provide feedback while cancelling.
Allow customers to reactivate cancelled subscriptions: Enabling this option will allow customers to reactivate their subscription from their self serve portal. Learn more about reactivation.
Allow customers to remove scheduled changes: Enabling this will allow your customers to cancel any changes that they have scheduled such as a subscription pause.
Allow customers to remove scheduled cancellation: Enabling this will allow your customers to remove any subscription cancellations that have been scheduled.
Allow customers to remove their primary payment method: Enabling this will allow customers to remove their primary payment method from the self serve portal.
Allow customers to pause subscriptions: Enabling this option will allow your customers to pause their subscriptions from the self serve portal. Please note that for this to work, you must have first enabled pause subscription for your site. Learn about Pausing Subscriptions.
Subscriptions will be paused: You can choose to either pause the subscription at the end of the term or immediately.
How long will subscriptions be paused: Available options are
You can enable this setting to configure fields that customers on contract subscription will see on their self-serve portal.
Override portal settings for subscriptions with contract terms: Enabling this option will allow users to override the portal settings that you configure here for subscriptions with contract terms.
Allow your customers to change subscriptions: Enabling this option will allow your customers to change the subscriptions on contract from the self-serve portal.
Allow your customers to cancel subscriptions: Enabling this option will allow your customers to cancel the subscriptions on contract from the self-serve portal.
Allow customers to reactivate canceled subscriptions: Enabling this option will allow your customers to reactivate the canceled subscriptions from the self-serve portal.
Allow customers to remove scheduled changes: Enabling this option will allow your customers to remove any subscription cancellations that have been scheduled.
Choose fields to display for subscriptions with contract terms: You can select the fields that you want to display for subscriptions on contract on the self-serve portal. You can select from the following fields:
Chargebee also allows you to configure certain advanced settings to make work easier for you and your customers. You can find these settings under Settings > Configure Chargebee > Advanced Settings
This Setting is common to Checkout and Self Serve Portal.
In this section, you will be able to:
You can disable the self serve portal by clicking the Disable button. If you disable this option, your customers can no longer access the self-serve portal.
You can view the preview of the self serve portal by clicking the Preview Checkout/Portal link in the Checkout and Self Serve Portal page.
Chargebee's In-app Customer Portal supports 3DS transactions. All you need to do is complete our SCA checklist, which facilitates us to start handling 3DS transactions via In-app 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 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.
1. How can I setup Plan/Addon quantity restrictions in Chargebee's Self-Serve Portal?
Plan-Addon quantity restrictions can be setup in Chargebee's Self-Serve Portal via json metadata. Here are a few samples:
Setup quantity based increments, in this case, the interval is set as 10, and the min qty is 10 and max qty is 100
{ "quantity_meta": {
"type": "range",
"min": 10,
"max": 100,
"step": 10
} }
Show specific quantity to be displayed
{"quantity_meta": {
"type": "fixed",
"values": [5, 6, 7, 8, 9, 10]
} }
2. Can gift subscriptions be viewed in the Self-serve Portal?
Yes, gift subscriptions are also included in the Portal. You can see a glimpse of that in this section.