Chargebee organization fields

This page lists all Chargebee-related organization (company) fields which are added to your Ortto account after integrating Ortto with Chargebee when configuring Chargebee as a new data source.

Working with Chargebee organizations

You can view or filter your Chargebee organizations in your CDP on the Organizations page.

Customize the field visibility and add Chargebee organization fields by clicking the cog icon, then select or clear the fields you want to show or hide.

Apply filters using the Chargebee organization fields or activities to view the Chargebee organizations that match the filter criteria. Learn more about Chargebee activities under Chargebee activities and attributes.

To filter organizations by the Chargebee organization fields:

On the the Organizations page, click Filter.
Select Chargebee organization, then select the fields to wish to use as filter conditions.
Click Done.

Learn more about creating filters under Working with filters.

Organization fields added from Chargebee

This table lists the Chargebee organization (company) fields that are added to your Ortto account after integrating Ortto with Chargebee.

Field	Type	Description
Name	Text (string)	The company name of the Chargebee customer. If a customer (contact) in your Chargebee account does not have a company name recorded, the Customer ID for the contact will be assigned as the value.
Customer ID	Text (string)	The Chargebee customer ID for the contact. If a customer (contact) does not have a customer ID in Chargebee, a 16-character ID will be set by default.
Payment method type	Text (string)	The type of payment source for the Chargebee company.
Payment method gateway	Text (string)	The name of the gateway the Chargebee company’s payment method is associated with.
Payment method gateway account ID	Text (string)	The gateway account the Chargebee company’s payment method is stored with.
Payment method status	Text (string)	The current status of the Chargebee company’s payment source.
Payment method reference ID	Text (string)	The Chargebee company’s payment method reference id.
Card status	Text (string)	The current status of the credit card connected to the Chargebee company.
Invoice notes	Text (string)	A Chargebee company-facing note added to all invoices associated with this resource.
Preferred currency code	Text (string)	The currency code of the Chargebee company’s preferred currency (ISO 4217 format). Applicable if Chargebee’s Multicurrency feature is enabled.
Promotional credits	Number (integer)	The promotional credits balance of the Chargebee company.
Unbilled charges	Number (integer)	The total unbilled charges for the Chargebee company.
Refundable credits	Number (integer)	The refundable credits balance of the Chargebee company.
Excess payments	Number (integer)	The total unused payments associated with the Chargebee company.
Created at	Time and date	Indicates when the Chargebee company resource was created in Chargebee.
Updated at	Time and date	Timestamp indicating when the Chargebee company was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.
Created from IP	Text (string)	The IP address of the Chargebee company.
Auto collection	Text (string)	A flag to indicate whether (`true`) or not (`false`) payments need to be collected automatically for the Chargebee company.
Offline payment method	Text (string)	The preferred offline payment method for the Chargebee company.
Billing date	Time and date	Indicates the Chargebee company’s monthly and yearly subscription renewal date (if Chargebee calendar billing with billing date support is enabled).
Billing date mode	Text (string)	Indicates whether the Chargebee company’s `billing_date` value is derived per the Chargebee account configurations or if it is specifically set (overriden). When specifically set, the `billing_date` will not be reset even when all of the monthly/yearly subscriptions are cancelled.
Billing day of week	Text (string)	Indicates the week day that renewals of all the Chargebee company’s weekly subscriptions are set (if Chargebee calendar billing with billing date support is enabled).
Billing day of week mode	Text (string)	Indicates whether the Chargebee company’s `billing_day_of_week` value is derived per the Chargebee configurations or if it is specifically set (overriden). When specifically set, the `billing_day_of_week` will not be reset even when all of the weekly subscriptions are cancelled.
Primary payment source ID	Text (string)	The primary payment source for the Chargebee company.
Backup payment source ID	Text (string)	Backup payment source for the Chargebee company. Used to collect payment if primary payment source fails.
Net term days	Number (integer)	The number of days within which the Chargebee company has to make payment for the invoice.
VAT number	Text (string)	The VAT/tax registration number for the Chargebee company.
VAT number validated time	Time and date	The recent VAT number validation time for the Chargebee company.
VAT number status	Text (string)	The VAT validation status of the Chargebee company. This is applicable if you have configured EU, UK or Australian taxes and the VAT number validation is enabled.
VAT number prefix	Text (string)	An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with `billing address` country as XI (which is United Kingdom - Northern Ireland).
Business customer without VAT number	Boolean	A flag to indicate whether (`true`) or not (`false`) a Chargebee company is a valid business without an EU/UK VAT number.
Allow direct debit	Boolean	A flag to indicate whether (`true`) or not (`false`) the Chargebee company can pay via Direct Debit.
Is location valid	Boolean	A flag to indicate whether (`true`) or not (`false`) the Chargebee company’s location is validated based on IP address and Card issuing country. If the location is valid, it returns `True`. If not, it returns `False`. Applicable only for EU, New Zealand and Australia
Taxability	Text (string)	Specifies if the Chargebee company is liable for tax.
Entity code	Text (string)	The exemption category of the Chargebee company, for USA and Canada. Applicable if you use Chargebee’s AvaTax for Sales integration.
Exempt number	Text (string)	Any string value that will cause a sale to be exempted. Chargebee recommends to use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee’s AvaTax for Sales integration.
Resource version	Number (integer)	Version number of the Chargebee resource. The `resource_version` is updated with a new timestamp in milliseconds for every change made to the resource. This field attribute will be present only if the resource has been updated after 2016-09-28.
Locale	Text (string)	Determines which region-specific language Chargebee uses to communicate with the Chargebee company.
PII cleared	Boolean	Indicates whether the Chargebee the contact associated with the company has had their personal information cleared.
Auto close invoices	Boolean	A flag to indicate whether (`true`) or not (`false`) to override for the Chargebee company the Chargebee site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled (in Chargebee).
Fraud flag	Text (string)	Indicates whether or not the Chargebee company has been identified as fraudulent.
Is e-invoice enabled	Boolean	A flag to indicate whether (`true`) or not (`false`) the Chargebee company is e-invoiced. When set to `true` or not set to any value, the company is e-invoiced so long as e-invoicing is enabled for their country. When set to `false`, the company is not e-invoiced even if e-invoicing is enabled for their country.
Deleted	Boolean	A flag to indicate whether (`true`) or not (`false`) the resource has been deleted.
Registered for GST	Boolean	A flag to indicate whether (`true`) or not (`false`) the Chargebee company is registered under GST. If set to `true` then the Reverse Charge Mechanism is applicable. This field is applicable only when Australian GST is configured.
Consolidated invoicing	Boolean	A flag to indicate whether (`true`) or not (`false`) invoices raised on the same day for the Chargebee company are consolidated. When present, this value overrides the default Chargebee site-level configuration. This attribute is applicable only when Chargebee’s Consolidated Invoicing is enabled.
Customer type	Text (string)	Indicates the Chargebee customer (company) type. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Client profile ID	Text (string)	Indicates the Client profile id for the Chargebee company.
Relationship parent ID	Text (string)	The ID of the Chargebee customer who is a parent (in a Chargebee account hierarchy relationship).
Relationship payment owner ID	Text (string)	The ID of the Chargebee customer who pays the invoices for this contact. Can be the customer (company) themselves or the `Relationship invoice owner ID`.
Relationship invoice owner ID	Text (string)	The ID of the Chargebee customer who is invoiced for charges incurred. Can be the customer (company) themselves or any parent in its Chargebee account hierarchy.
Use default hierarchy settings	Boolean	A flag to indicate whether (`true`) or not (`false`) the Chargebee site-default settings are being used for controlling access to the Chargebee company’s information.
Entity identifier scheme	Text (string)	The Peppol BIS scheme associated with the `VAT number` of the Chargebee company.
Entity identifier standard	Text (string)	The standard used for specifying the `Entity identifier_scheme`. Currently only `iso6523-actorid-upis` is supported and is used by default when not provided.
Subscription item price IDs	Text (string)	The unique identifier of the subscription item price. This field will be populated with the subscription plan ID if you are on Chargebee API version 2.x or later.
Subscription plan IDs	Text (string)	The unique identifier of the subscription item. This field will be populated with the subscription plan ID if you are on Chargebee API version 1.x.
Total spent	Currency	The amount a customer (company) has paid for items for all time.
MRR	Currency	Monthly recurring revenue for the subscription. The value depends on the type of currency. Note: This may not return accurate values since updated asynchronously.
ARR	Currency	Annual recurring revenue for the subscription.The value depends on the type of currency. Note: This may not return accurate values since updated asynchronously.
Is trial	Boolean	A status value for the company’s subscription; the subscription is in trial.
Last subscriptions state	Text (string)	The last (most recent) state of the company’s subscription, e.g. `New`, `Churned`, etc.
Address First name	Text (string)	The first name of the Chargebee billing contact.
Address Last name	Text (string)	The last name of the Chargebee billing contact.
Address email	Text (string)	The Chargebee contact’s billing email address.
Address Company	Text (string)	The Chargebee contact’s company name.
Address phone	Text (string)	The Chargbee contact’s billing phone number.
Address Line 1	Text (string)	The Chargebee billing contact’s address, line 1.
Address Line 2	Text (string)	The Chargebee billing contact’s address, line 2.
Address Line 3	Text (string)	The Chargebee billing contact’s address, line 3.
Address city	Text (string)	The Chargebee billing contact’s city.
Address State code	Text (string)	The Chargebee billing contact’s ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India.
Address State	Text (string)	The Chargebee billing contact’s state or province.
Address Country	Text (string)	The billing address country of the Chargebee contact, in ISO 3166-2 country code.
Address Zip	Text (string)	The Chargebee billing contact’s zip or postal code.
Address validation status	Text (string)	The Chargebee billing contact’s address verification status.
Subscription IDs	Text (string)	A unique and immutable identifier for a subscription. If not provided, it is autogenerated.
Coupon IDs	Text (string)	Used to uniquely identify the coupon created in Ortto to integrate with Chargebee.
Addon IDs	Text (string)	The subscription item type (addon).
Status	Text (string)	The current status of a subscription associated with the company.
Current term end	Time and date	The end of the current billing period of a subscription associated with the company. Subscription is renewed immediately after this.
Next billing at	Time and date	The date/time at which the next billing for the company’s subscription happens.