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
  • 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
  2. Site Configuration
  3. Mandatory Fields
  1. Billing
  2. Site Configuration
  3. Mandatory Fields

Mandatory Fields

The customer and subscription-related data that is collected and stored in Chargebee is crucial to your business for various reasons. This data helps you in knowing your customers well, or in better communication, marketing automation, or even for some integration workflows as mandated by the third-party applications.

Request access to avail this feature.

When it comes to data collected in Chargebee, certain fields in each module are marked as mandatory by default, while most others are not. For example, the Name, Id, Bill Every, Currency, and Price fields are mandatory (by default) while creating a Plan.

Chargebee allows you to define mandatory fields for the key modules, to capture information that is crucial for your business. For instance, the email ID field is not mandatory for customers by default. By marking this field as mandatory, you can collect the email addresses of all your customers and use the data for drip campaigns or other marketing automation.

You can define mandatory fields in Chargebee for the following modules:

  • Customers
  • Plans
  • Addons

List of Supported System Fields

The following is the list of supported system fields:

ModuleField Name
CustomerFirst Name
Last Name
Company
Email
Phone
PlanName
Invoice Name
Description
Setup Cost
AddonName
Invoice Name
Description

Configuring Mandatory Fields

Kindly contact support to avail this feature.

After having the feature enabled on your Chargebee site, you can define mandatory fields for any module by following these steps:

  1. Click Settings > Configure Chargebee > Advanced > Mandatory Fields.

  2. On the Mandatory Fields page, all the fields for Customers, Plans, and Addons are displayed.

  3. Navigate to the module for which you are defining mandatory fields, and select the fields to mark them as mandatory. Fields that are mandatory by default cannot be modified.

    image
  4. Once you have marked the fields as mandatory, click Apply.

The respective fields become mandatory while creating a new record or cloning a record in the Chargebee site.

Classic UI users

Here's how the mandatory fields are displayed in Classic UI:

However, for existing records, the fields become mandatory only when you edit them.

Note

  • You can even mark custom fields as mandatory. You can do this either from the Mandatory Fields page as explained above, or while creating a custom field.
  • Chargebee's Checkout and Self-Serve Portal also support marking fields as mandatory. If you are using Chargebee's Checkout or Self-Serve Portal, make sure that all the fields that you have configured as mandatory are or passed as a hidden parameter from your website. However, all fields that are mandated for Checkout are not required to be marked as mandatory here.
  • If you are using the gift subscriptions feature in Chargebee, mark only the fields that you are collecting for gifter and receiver as mandatory fields. We also recommend that you do not mark any customer-related fields as mandatory.

Was this article helpful?