The available fields in Customers and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Account Manager | The internal team member (usually a sales or customer success rep) is responsible for managing the relationship with this customer. Useful for tracking ownership and accountability. |
| Acquisition Channel | Indicates the channel through which the customer was acquired. |
| Acquisition Cost | The monetary cost incurred to acquire the customer (also known as CAC – Customer Acquisition Cost). |
| Acquisition Currency | The currency in which the acquisition cost was recorded. |
| Acquisition Mode | Describes the method or journey by which the customer was acquired. |
| Allow Direct Debit | It indicates whether the customer can pay via Direct Debit. |
| Auto-Collection | When the customer has a payment_method of type card, this attribute determines whether to automatically charge the card whenever an invoice status is payment_due. |
| Billing Day of Week | Billing Day of Mont's day. Possible values are Sunday , Monday … Saturday. |
| Business Type | Refers to the legal or operational structure of a customer's organization. |
| Business Vertical | Refers to the industry or sector the customer operates in. |
| Channel | Specifies where the subscription was created and how it's managed. - web – Created directly via Chargebee UI or API. Fully editable. - app_store – Synced from Apple App Store. Cannot be modified via UI/API. - play_store – Synced from Google Play Store. Cannot be modified via UI/API. |
| Company | The company name. |
| Consolidated Invoicing | Indicates whether invoices raised on the same day for the customer are consolidated. When present, this value overrides the default configuration at the site-level. This attribute is applicable only when Consolidated Invoicing is enabled. |
| Country | The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. |
| Created From IP Address | The IP address of the customer when this customer record was created. It's mainly used for referral integrations and validating VAT if the customer is in the EU or UK. |
| Creation Date | Timestamp indicating when this customer resource was created. |
| Customer ID | The unique identifier of the customer resource. |
| Customer Success Agent | The person responsible for post-sale relationship, renewals, and overall customer health. |
| Customer Type | The customer_type is an optional, enumerated string used only when Chargebee's AvaTax for Communications integration is enabled. It indicates the Avalara customer type and can be one of the following: residential (individual user), business (a business entity), senior_citizen (an individual eligible for senior citizen tax benefits), or industrial (an industrial business). |
| The email of the customer. Configured email notifications will be sent to this email. | |
| Exempt Category | This indicates the exemption information. The customer can customize customer exemptions based on a specific Location, Tax level (Federal, State, County, and Local), Category of Tax, or Tax Name. |
| Exemption Number | Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's AvaTax for Sales integration. |
| First Name | First name of the customer. |
| Fraud Flag | The fraud_flag is an optional, enumerated string field that indicates a customer's fraud status. It can take one of three values: safe, suspicious, or fraudulent. A value of safe means the customer has been explicitly marked as trustworthy. The suspicious status indicates that the payment gateway has identified the customer as potentially fraudulent. Finally, fraudulent signifies that the customer has been confirmed and marked as fraudulent. This field is useful for risk assessment and determining how to handle customer interactions based on their fraud status. |
| Last Name | Last name of the customer. |
| Locale | Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication. |
| Net D | The number of days within which the customer has to make payment for the invoice. |
| Offline Payment method | The offline_payment_method is an optional, enumerated string field that specifies the customer's preferred offline payment method. It can take one of the following values: no_preference, indicating the customer has no specific preference; cash, for payments made in cash; check, for payments made via check; and bank_transfer, for payments made through a bank transfer. This field helps businesses understand and accommodate the customer's preferred method of offline payment. |
| Phone | Phone number of the customer. |
| Primary Payment Source ID | The identifier of the customer's primary payment source. |
| Product Usage | An indicator of how much or how often the customer is using the product. |
| Sales Agent | The individual from the sales team who closed or influenced the deal. |
| Secondary Payment Source ID | The identifier of the customer's backup payment source. |
| Solution Partner | Indicate which solution partner (if any) was associated with the acquisition or servicing of the end customer. |
| State | Indicates the State or Province |
| Taxable | Specifies if the customer is liable for tax |
| VAT Number | The customer's VAT/tax registration number. For customers with billing_address country as XI (which is United Kingdom—Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix. |
Was this article helpful?