Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Configuring Fields and Labels

You can configure the fields and labels on Checkout and Portal to collect the required information from your customers.

Working with fields

Configure fields

Sign in to the Chargebee site, navigate to Settings > Configure Chargebee > Checkout and Self Serve Portal > Fields.

See also

Add product images to your product catalog items to display them on the checkout pages.

Enable a field

Turn the toggle button on or off to enable or disable a field.

The following screenshot shows the toggles for enabling or disabling individual fields in the billing or shipping address.

Reorder fields

You can drag and drop some fields to change their order on the checkout page.

Note

You cannot reorder fields under the following sections:

Edit a field name

You can edit a field's name and set properties such as mandatory, read-only, and show/hide. The below screenshot list the properties you can set for a field. For example, set the email field as mandatory during checkout.

Note

Depending on the field, a subset of the properties will be available.

Configurable fields in Checkout

You can configure the fields for the following sections.

Account Information

Account fields collect primary customer information, such as name, email, company, and phone. They also collect custom fields from the checkout page.

Note

  • You must set at least one field under Account information to Show or Mandatory when you set field properties. Otherwise, the account information page is skipped during checkout. However, the account information still appears as read-only on the final checkout page.
  • When the customer selects UPI or Netbanking, and especially when the payment gateway is Razorpay, the following fields always appear on checkout screens: First Name, Last Name, Email, Phone. If Chargebee has already captured the customer's information, it's prefilled in Checkout.

Custom fields for subscription

Configure custom fields to collect subscription-related information from your customers.

Billing

Configure billing fields to collect your customer's billing information such as an address, phone number, name, VAT number, and more. Turn the toggle buttons on or off to enable or disable granular components of the address.

Note

  • To configure tax details such as VAT or GST, you must set billing country as mandatory in your tax settings.Furthermore, you can select to display the addresses on the checkout page, self-serve portal, or both.
  • Billing fields cannot be reordered.

Shipping

Configure shipping fields to collect your customer's shipping information, such as shipping address, name, phone number, and more. Turn the toggle buttons on or off to enable or disable granular components of the address.

  • Enable the Use the same configuration as billing setting to apply billing address configured properties to the shipping address.
  • Enable the In checkout show the option "Ship to my billing address" to allow your customers to choose billing address as the shipping address during checkout.

Note

  • The Ship to my billing address option does not appear when the Checkout is created via API for an existing customer who already has one or more billing address fields in Chargebee.
  • Shipping fields cannot be reordered.

Payments

Configure payment fields to collect your customer's payment-related information such as card number, expiry, and Cvv. Card Number and Expiry will be collected by default and stored in your payment gateway.

Note

Payments fields cannot be reordered.

Overview

Checkout supports presenting legal agreements to customers during the purchase process.

You can add and manage multiple agreements, such as a terms of service, a privacy policy, or a refund policy, to meet various regulatory requirements. This helps you comply with legal standards around the world, such as those outlined by the Federal Trade Commission (FTC), which require businesses to provide clear, truthful, and accessible information about agreements and offer cancellation methods that are as easy as the sign-up process.

Agreements support rich text formatting, including hyperlinks to additional resources or policies, as needed. Support for multiple languages based on the customer's locale is also included.

Chargebee logs timestamped data of customer agreement during checkout, which serves as proof in cases of disputes or chargebacks. An audit log of changes made to the legal agreements is also available to help improve transparency and compliance.

Add a legal agreement

To add a legal agreement to Checkout:

  1. Select Add legal agreement.
  • Under Legal Agreement Name, enter a name to identify the agreement within Chargebee. This name, once saved, cannot be edited later.
  • Click the tab for the language in which you want to add the legal agreement.
  • Under Legal Agreement, enter the agreement text. Use rich text formatting as needed.
  • Select Display a checkbox at checkout to obtain consent if you want the customer to explicitly agree before completing checkout.
  • Repeat the steps for each configured language.
  • Select Save.
  • Repeat the steps to add more agreements.

Edit a legal agreement

You can edit a legal agreement, view its audit log, and restore previous versions. To do so:

  1. Click the more options menu for the agreement you want to edit.
  • Select View.
  • Edit the agreement text as needed.
  • Select Update.
  • Alternatively, under Audit Logs, find previous versions of the agreement listed in reverse chronological order.
  • Select Restore Version next to the version you want to restore.
  • Click Confirm in the dialog that appears.

Archive or restore a legal agreement

Archived legal agreements aren't displayed on Checkout pages. Restored agreements become visible again. To archive or restore a legal agreement:

  1. Click the more options menu for the agreement you want to archive or restore.
  • Select Archive or Restore.
  • Click Confirm in the dialog that appears.

View consent history

Each time a customer agrees to a legal agreement and completes a Checkout session, a log of the event is created in Chargebee Billing. To view this:

  1. Log in to Chargebee Billing.
  • Select Customers in the left navigation.
  • Click the customer name to open the details page.
  • Scroll to Legal Information. Legal agreements are listed in descending order by date of consent.
  • Click View details to view event information for the Checkout session.

Configure this field to collect consent from your customers during checkout. You can add consent, agreement labels and set up consent checkboxes for the checkout and Self-Serve portal.

Working with Labels

You can customize the field labels and messages displayed in the Checkout Pages and Self-Serve Portal.

To access the labels

  • Sign in to the Chargebee site, navigate to Settings > Configure Chargebee > Checkout and Self Serve Portal > Labels.

Add a label

To add a label, perform these steps.

  1. Click +Add more copy/text.
  2. Search the required labels in the search box.
  3. Click Add.
  4. Click Apply.
  5. Click Publish.

The label changes are now visible to your customers.

Here is an example of how the Checkout labels work.

The following illustration describes adding a note to the payment method screen during checkout. This note will be displayed for all the users on the Payment method screen during checkout.

During checkout, the note will appear as shown below:

Configuring thank you messages

You can set up messages that will appear to your customers after they checkout. Full page checkout Thank you page supports both, Thank you title and Thank you message labels.

To add a Thank you message or title, perform these steps:

  1. Go to Messages.
  2. Click Edit and add the message.
  3. Click Apply.
  4. Click Publish.

Was this article helpful?