Docs

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

Data Sources

Report Builder is a powerful capability that allows you to create your own reports. The data in Chargebee is remodeled and stored as tables called Data Sources. You can use this information to create reports. Each of these Data Sources has multiple fields.

Note:

  • To know more about the availability of this feature, visit our plans and pricing page.

The Report Builder allows you to create reports using the following data sources.

Standard Data Sources

Premium Data Sources

Note:

The following data sources, including Invoice Line Items, Credit Note Line Items, Monthly Subscription History, Yearly Subscription History, Revenue Recognition, Customer Balances, Monthly Component History, Yearly Component History and Applied Credits are available only for the customers with RevenueStory premium license.

Coupons

The available fields in the 'Coupons' data source and their corresponding descriptions are listed below.

FieldDescription
CurrencyThe currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons alone.
Duration TypeDisplays if the coupon can be used one_time, forever, or for a limited_period.
RedemptionsDisplays the number of times a coupon was redeemed.
Created OnTimestamp indicating when this coupon was created.
Valid TillDisplays the date until which the coupon can be applied to new subscriptions.
Coupon IDDisplays the unique identifier for the coupon.
Addon ApplicabilityDisplays if the coupon can be applied to add-ons. Possible values are none, all, specific, not_applicable.
Maximum RedemptionsDisplays the maximum number of times the coupon can be redeemed.
DurationDisplays the duration in months for the coupon to be applied. Applicable only for limited period coupon.
Apply OnDisplays the invoice items for which this discounts need to be applied. Possible values are invoice_amount, each_specified_item.
NameDisplays the coupon name.
Archived OnTimestamp indicating when this coupon was archived.
Invoice NameDisplays the invoice name of the coupon.
Discount PercentageDisplays the discount value in percentage.
StatusDisplays the status of the coupon. Possible values are active, expired, archived, deleted.
Discount TypeSpecifies the time duration this coupon is applicable. Possible values are one_time, forever, limited_period.
Plan ApplicabilityDisplays if the coupon can be applied to plans. Possible values are none, all, specific, not_applicable.
Discount AmountDisplays the discount value in dollars.

Credit Notes

The available fields in the 'Credit Notes' data source and their corresponding descriptions are listed below.

FieldDescription
Voided OnTimestamp indicating the date and time the credit note got voided.
Credit Note IDDisplays the unique identifier of the credit note.
Amount RefundedDisplays the refunds issued from the Credit Note.
Round Off AmountDisplays the rounded-off amount.
Amount AllocatedDisplays the total credits allocated to invoices.
VAT NumberDisplays the VAT number of the customer for whom this Credit Note is raised.
Price TypeDisplays the price type of the Credit Note.
Reason CodeDisplays the reason for issuing this Credit Note. The following reason codes are supported now. Possible values are write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent.
Available CreditsDisplays the credits that are yet to be used from the credit note.
Credit Note StatusDisplays the status of the credit note. Possible values are adjusted, refunded, refund_due, voided.
Sub TotalDisplays the sub total of the credit note.
Created OnDisplays the date when the Credit Note was issued.
TypeDisplays the type of the credit note. Possible options are Adjustment and Refundable.
Refunded OnDisplays the time when credits were completely used or refunded.
TotalCredit Note amount in dollars.
Total(Transaction Currency)Credit Note amount in the transaction currency.
CurrencyThe currency code (ISO 4217 format) for the credit note.

Customers

The available fields in Customers and their corresponding descriptions are listed below.

FieldDescription
Account ManagerThe 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 ChannelIndicates the channel through which the customer was acquired.
Acquisition CostThe monetary cost incurred to acquire the customer (also known as CAC – Customer Acquisition Cost).
Acquisition CurrencyThe currency in which the acquisition cost was recorded.
Acquisition ModeDescribes the method or journey by which the customer was acquired.
Allow Direct DebitIt indicates whether the customer can pay via Direct Debit.
Auto-CollectionWhen 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 WeekBilling Day of Mont's day. Possible values are Sunday , Monday … Saturday.
Business TypeRefers to the legal or operational structure of a customer's organization.
Business VerticalRefers to the industry or sector the customer operates in.
ChannelSpecifies 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.
CompanyThe company name.
Consolidated InvoicingIndicates 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.
CountryThe billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
Created From IP AddressThe 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 DateTimestamp indicating when this customer resource was created.
Customer IDThe unique identifier of the customer resource.
Customer Success AgentThe person responsible for post-sale relationship, renewals, and overall customer health.
Customer TypeThe 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).
EmailThe email of the customer. Configured email notifications will be sent to this email.
Exempt CategoryThis 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 NumberAny 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 NameFirst name of the customer.
Fraud FlagThe 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 NameLast name of the customer.
LocaleDetermines 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 DThe number of days within which the customer has to make payment for the invoice.
Offline Payment methodThe 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.
PhonePhone number of the customer.
Primary Payment Source IDThe identifier of the customer's primary payment source.
Product UsageAn indicator of how much or how often the customer is using the product.
Sales AgentThe individual from the sales team who closed or influenced the deal.
Secondary Payment Source IDThe identifier of the customer's backup payment source.
Solution PartnerIndicate which solution partner (if any) was associated with the acquisition or servicing of the end customer.
StateIndicates the State or Province
TaxableSpecifies if the customer is liable for tax
VAT NumberThe 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.

Customer Balance

FieldDescription
Promotional CreditsDisplays the promotional credits balance of the customer.
Unbilled ChargesDisplays the total unbilled charges for the customer.
Refundable CreditsDisplays the refundable credits balance of the customer.
Excess PaymentsDisplays the total unused payments associated with the customer.
CurrencyThe currency code (ISO 4217 format) of the coupon.

Invoices

The available fields in the 'Invoices' data source and their corresponding descriptions are listed below.

FieldDescription
Expected Payment DateDisplays the expected payment date recorded for the invoice.
Paid OnTimestamp indicating the date and time when the invoice was paid.
Invoice IDDisplays the unique identifier of the invoice.
First InvoiceDisplays True if the invoice is a first invoice, false, if otherwise. In the case of a non-recurring invoice, it indicates the first invoice raised for the customer.
Amount To CollectDisplays the rounded-off invoice amount.
Net DDisplays the number of days within which the invoice has to be paid.
Next Retry OnTimestamp indicating when will the next attempt to collect payment for the invoice will occur.
Dunning StatusDisplays the dunning status of the invoice. Possible values are in_progress, exhausted, stopped, success.
CurrencyThe currency code (ISO 4217 format) of the invoice amount.
Total Tax AmountDisplays the total tax amount for the invoice.
Tax Amount (Transaction Currency)Displays the total tax amount for the invoice in the transaction currency.
Write Off AmountDisplays the amount written off against the invoice.
Is Recurring InvoiceDisplays 'Yes' if the invoice is recurring, 'No', if otherwise.
Amount DueDisplays the total amount to be collected. This includes invoice's payments in progress.
Amount AdjustedDisplays the total adjustments made against the invoice.
Round Off AmountIndicates the rounded-off amount.
Amount PaidDisplays the total payments received for the invoice.
Advance ChargesBoolean indicating any advance charge is present in this invoice.
Credits AppliedDisplays the total credits applied against the invoice.
Issued OnClosing date of the invoice. Typically this is the date on which invoice is generated. If you have "wait and notify to send invoices enabled for usage based billing", then the date displayed here will be different.
Due DateDisplays the invoice Due Date.
Price TypeThe price type of the invoice. Possible values are tax_exclusive, tax_inclusive.
StatusDisplays the current status of this invoice. Possible values are paid, posted, payment_due, not_paid, voided, pending.
TotalInvoiced amount in dollars.
Total (Transaction Currency)Invoiced amount in the transaction currency.
Po NumberDisplays the Purchase Order Number for this invoice.
VAT NumberDisplays the Vat Number.
Sub TotalDisplays the Sub total of the invoice.
Voided OnTimestamp indicating the date and time the invoice got voided.

Orders

The available fields in Orders and their corresponding descriptions are listed below.

FieldDescription
Order IDUnique identifier of an order.
Document NumberSerial number of an order.
StatusCurrent status of an order.
Reason CodeReason for an order cancellation.
Payment StatusIndicates if the payment for an order is in a Paid or Not Paid status.
Order TypeIndicates if an order type is Manual or System generated.
Price TypeIndicates if the price of an order is Inclusive or Exclusive of tax.
Reference IDAn ID used to refer to an order in a third-party application.
Fulfillment StatusStatus of an order in a third-party application.
NoteCustom note added for an order.
Tracking IDAn ID that is used to track the status of an order.
Batch IDAn ID that is used to identify a group of orders.
Created ByThe source of order creation.
Shipment CarrierDetails of the Shipment Carrier.
CurrencyCurrency code of an invoice in ISO 4217 format.
Invoice Round Off AmountTotal round off amount of an order's invoice.
Tax AmountTotal tax amount of an order.
Amount PaidTotal amount paid for an order.
Amount AdjustedTotal amount adjusted for an order.
Refundable Credits IssuedTotal amount of refundable credits issued for an order.
Refundable CreditsTotal amount of credits refundable for an order.
Rounding AdjustmentProvides information on the adjustment. If the value is $13.23 and they round off the final price to 13, then the adjustment here is -23 cents.
Order DateThe date when the order was placed.
Shipping DateThis is the date on which the order is/has to be shipped.
Paid OnDate and time of invoice payment for an order.
Shipping Cut Off DateThe time after which an order becomes unserviceable. need info
Created OnDate and time when the order was created.
Last Status Update AtDate and time of the last order update.
Delivered OnDate and time of order delivery.
Shipping OnDate and time of order shipment.
Canceled OnDate and time when the order was cancelled.
Discount AmountTotal amount of discount provided for an order.
Sub TotalSub total amount of an order.
TotalTotal amount charged for an order.
Total (Transaction Currency)Total amount charged in transaction currency for an order.
Is GiftedIndicates if the order is a gift or not.

Payments

The available fields in the 'Payments' data source and their corresponding descriptions are listed below.

FieldDescription
Fraud FlagIndicates whether or not the transaction has been identified as fraudulent. Possible values are safe, suspicious,fraudulent.
Gateway Transaction IDDisplays the ID with which this transaction is referred by the gateway.
Gateway Account IDDisplays the gateway used for the transaction.
Masked Card NumberDisplays the masked card number used for the transaction. Applicable only for 'Card' Payment Method.
Capturable AmountDisplays the unused but authorized amount present for this transaction. Applicable only for Authorization transactions.
Unused AmountDisplays the unused amount present for this transaction. Applicable only for Payments.
Authorization Reason CodeTDisplays the type of authorization. Possible values are blocking_funds, verification.
Settled OnDisplays the time at which the final status of the transaction has been marked.
Reference Authorization IDDisplays the original authorization transaction id that got captured. Applicable only for payment transactions.
AmountDisplays the amount for the transaction.
Amount (Transaction Currency)Displays the amount in the specified transaction currency for the payment.
Reversal Transaction IDDisplays the reversal transaction id. Applicable only for payment transactions.
Voided OnTimestamp indicating when the payment was voided or authorization expired at gateway.
Payment GatewayGateway through which this transaction was done. Applicable only for 'Card' Payment Method.
Error CodeDisplays the Error code received from the payment gateway on failure.
StatusDisplays the status of this transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention.
CurrencyThe currency code (ISO 4217 format) for the transaction.
Reference NumberDisplays the reference number for the transaction. e.g check number in case of 'check' payments.
TypeDisplays the type of the transaction. Possible values are authorization, payment, refund, payment_reversal.
Transaction DateIndicates when this transaction occurred.
Fraud ReasonDisplays the description why the transaction was marked as fraud/suspicious.
Transaction IDDisplays the transaction ID.
Payment MethodDisplays the Payment Method of this transaction. Possible values are card, cash, check, chargeback, bank_transfer, amazon_payments, paypal_express_checkout, direct_debit, alipay, unionpay, apple_pay, wechat_pay, ach_credit, sepa_credit, other.

Products

The available fields in Products and their corresponding descriptions are listed below.

FieldDescription
Plan NameThe display name of the plan.
Plan PeriodDisplays the period of the plan.
SKUDisplays the Product name/code used in your third party accounting application.
PriceThe price of the plan.
Account CodeDisplays the Account code of the plan used for integration purposes.
Invoice NameDisplays the invoice name.
Plan CurrencyThe currency code (ISO 4217 format) of the plan.
Free QuantityDisplays the number of free units.
Pricing ModelDisplays the pricing model.
Tax CodeDisplays the tax code in case of Avalara integration.
Trial Period UnitDisplays the unit for the trial period. Possible values are day and month.
Enabled in Self-Serve PortalDisplays 'Yes' if the customers can change their subscription using the self serve portal. Displays 'No', if otherwise.
TaxableDisplays 'Yes' if the plan is taxable, 'No', if otherwise.
StatusDisplays the status of the plan. Possible values are active, archived.
Charge TypeDisplays if the charges are recurring, or non-recurring.
Plan Setup FeeDisplays the one time set up free.
Trial PeriodDisplays the trial period for the plan/add-on.
Product TypeDisplays if the product type is a plan or add-on.
Accounting Category 1Displays the name of the category of your product in Xero. If you've integrated with QuickBooks, this will be the "Class". Uses the format "<Category>:<Name>". E.g. "Region: North".
Accounting Category 2Displays the name of the category of your product in Xero. Uses the format<Category>:<Name>". E.g. "Region: North".
Billing CyclesThe number of billing cycles the subscription is active.
Billing Frequency UnitDefines billing frequency in association with billing period. Possible values are week, month, year.
Enabled in Hosted PagesDisplays True if checkout through plan specific URL is enabled. Displays False if otherwise.

Refunds

The available fields in the 'Refunds' data source and their corresponding descriptions are listed below.

FieldDescription
CurrencyThe currency code (ISO 4217 format) for the transaction.
AmountDisplays the amount refunded for the transaction.
Amount (Transaction Currency)Displays the amount in the specified transaction currency for the refund.
StatusDisplays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention
Transaction IDDisplays the transaction ID.
Settled OnIndicates the time at which the final status of the transaction has been marked.
Gateway Account IDDisplays the gateway account used for the transaction.
Payment MethodDisplays the Payment Method of the transaction. Possible values are card, cash, check, chargeback, bank_transfer, amazon_payments, paypal_express_checkout, direct_debit, alipay, unionpay, apple_pay, wechat_pay, ach_credit, sepa_credit, other.
Transaction DateIndicates when this transaction occurred.
Fraud FlagIndicates whether or not the transaction has been identified as fraudulent. Possible values are safe, suspicious, fraudulent.
TypeDisplays the type of the transaction. Possible values are authorization, payment, refund, payment_reversal.
Payment GatewayDisplays the gateway through which the transaction was done. Applicable only for 'Card' Payment Method. Possible values are chargebee, stripe, braintree, authorize_net, paypal_pro, pin, eWay, eway_rapid, worldpay, balanced_payments, Bambora, Bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, amazon_payments, paypal_express_checkout, gocardless, adyen, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, not_applicable.
Masked Card NumberDisplays the masked card number used for the refund transaction. Applicable only for 'Card' Payment Method.
Reference NumberDisplays the reference number for the transaction. e.g check number in case of 'check' payments.
Voided OnTimestamp indicating when the payment was voided or authorization expired at gateway.
Gateway Transaction IDDisplays the ID with which this transaction is referred in gateway.
Reference Payment IDDisplays the reference payment ID. Applicable only for refund and reversal transactions.
Error CodeDisplays the Error code received from the payment gateway on failure.
Fraud ReasonDisplays the reason why the transaction was marked as fraud/suspicious.

Subscriptions

The available fields in Subscriptions and their corresponding descriptions are listed below.

FieldDescription
Canceled OnTime at which subscription was cancelled or is set to be cancelled.
Reason CodeReason code for cancellation. Available options are Not Paid, No Card, Fraud Review Failed, Non Compliant EU Customer, Tax Calculation Failed, Currency incompatible with Gateway, Non Compliant Customer.
Plan QuantityDisplays the plan quantity for the subscription.
CurrencyThe currency code (ISO 4217 format) of the subscription.
Subscription Billing PeriodDisplays the billing period for the subscription
Current PlanThe name of the current plan associated with a subscription.
Recurring Discount MRRRecurring discount amount associated with a subscription.
Current Billing Term Start DateStart of the current billing term.
Auto-CollectionDefines whether payments need to be collected automatically for this subscription. Overrides customer's auto-collection property.Available options are:On - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available.Off - Automatic collection of charges will not be made for this subscription. All payments must be recorded offline
Trial EndEnd of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'trial' state when it starts.
Billing FrequencyDisplays the billing period of the subscription.
Total Amount DueTotal invoice due amount for the subscription. Note: Not supported if consolidated invoicing is enabled or when the subscription is for the customer who is in hierarchy and the parent of this customer owns and pays for the invoices of the subscription.
Activated OnTime at which the subscription moved from 'In_trial' state to 'Active' state.
Next Billing OnThe next billing date.
Due InvoicesTotal number of invoices that are due for payment. Note: Not supported if consolidated invoicing is enabled or when the subscription is for the customer who is in hierarchy and the parent of this customer owns and pays for the invoices of the subscription
Subscription IDUnique identifier for a subscription.
Created From IP AddressThe IP address of the user. (Primarily used by refersion integration to track/log affiliate subscription.)
Initial Plan NameThe name of the first plan associated with a subscription.
Subscription Start DateDisplays the subscription start date. Will be null for 'future' subscriptions as it is yet to be started.
Subscription StatusCurrent status of the subscription.
CurrencyThe currency code (ISO 4217 format) of the subscription.
Remaining Billing CyclesThe total number of billing cycles for the subscription.
Current Billing Term End DateEnd date of the current billing term.
Current Plan Unit PriceDisplays the unit price for the subscription. (In case the price is overridden, then that amount will be displayed)
Trial Period Start DateStart of the trial period for the subscription. Presence of this value for 'future' subscription implies the subscription will go into 'trial' state when it starts.
Payment SourceUnique identifier of the payment method attached to the subscription.
Current Subscription Plan Free QuantityDisplays the number of free units for the subscription
Due SinceDisplays the number of days/date the payment is due. Note: Not supported if consolidated invoicing is enabled or when the subscription is for the customer who is in hierarchy and the parent of this customer owns and pays for the invoices of the subscription.
Future Subscription Start DateThe start date for future subscription.
Initial Active PlanThe name of the first active plan associated with a subscription.
Created OnSubscription created time.
PO NumberPurchase Order Number for the invoice.
Current Subscription Setup FeeThe set up associated with the subscription.
Scheduled ChangesDisplays true if there are changes scheduled for the next renewal.
Current MRRDisplays the current monthly recurring revenue of the subscription.
Current MRR (Transaction Currency)Displays the current monthly recurring revenue of the subscription in the specific transaction currency.
Committed CMRR (Monthly Recurring Revenue)Displays the committed monthly recurring revenue for the future period.
Discount CMRR (Committed Monthly Recurring Revenue)Displays the committed monthly recurring discount amount.
Has scheduled advanced invoicesGenerate invoices in advance for an upcoming renewal or set of renewals. You can set up a plan from when advance invoices start generating for the lifetime subscription.
Offline payment methodDisplays the preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.
Free periodDisplays the period for which the subscription is free-of-charge.
Free period unitDefines additional free period in association with the billing period.
Auto close invoicesSet to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.
Pause DateWhen a pause has been scheduled, it is the date/time of scheduled pause. When the subscription is in the paused state, it is the date/time when the subscription was paused.
Resume dateFor a paused subscription, it is the date/time when the subscription is scheduled to resume. If the pause is for an indefinite period, this value is not returned.
Cancellation Initiated dateThis is the date/time at which the most recent cancellation schedule for the subscription was created in Chargebee. Applicable only for cancelled subscriptions or subscriptions that are scheduled for cancellation.

Multientity

FieldDescription
Entity IDUnique ID of the entity.
Entity NameName of the entity.

Product Family

Field NameDescription
Product Family NameName of Product family.
Product Family IDID of the Product family.
Product TypeType of product. It can be plans, addons, or charges.
Product GroupCustom field mapped to any column like plans, addons, or charges.
Internal Product NameThe internal name is provided to identify product type plans, addons, or charges.
External Product NameReference used by Chargebee to identify product type plans, addons, or charges.
Product IDID of the particular product type plans, addons, or charges.
External Price Point NameExternal name is used for display in invoices, quotes, checkout, and the self-serve portal.
Internal Price Point NameThe internal name is provided to identify a product type price point.
Price Point IDReference used by Chargebee to identify this plan price point.
Price Point Billing FrequencyFrequency of billing of a product type price point (For example. Every three months)
Price Point PeriodNumber of months/years/days of a particular product type price point
Price Point SKUThe Product name/code used in third-party accounting applications.
Metered Product TypeA boolean field displaying if a product type is metered or not.
Product Type Price PointActual Price offered as a particular price point set for the product type - plan/add-on/charge for example, 20$ for a monthly plan.
Price Point Accounting CodeThe account code of the plan price point is used for integration purposes.
Price Point Accounting ClassThe account code of the plan price point is used for integration purposes.
Price Point CurrencyCurrency set for a particular plan price point.
Price Point Free QuantityFree quantity set for a particular plan price point
Price Point Pricing ModelPricing model of a plan price point. For example, per unit, flat fee, and so on.
Price Point Tax Code (HSN)Tax code at the plan price point in case of Avalara integration.
Displayed in Self-Serve PortalValue is True if checkout through a product type-specific URL is enabled. Value is False otherwise.
Taxable Price PointThe value is Yes if the product type price point is taxable, or No otherwise.
Product Type StatusThe status of the product type. Possible values are active and archived.
Product Price Point StatusThe status of the product type price point. Possible values are active and archived.
Charge TypeDisplays if the charges are non-recurring. With PC2.0, it can be charge(pre-configured) or quick charge(ad-hoc line item).
Price Point Trial Period UnitThe unit for the trial period for a particular product type price point. Possible values are day and month.
Price Point Trial PeriodThe trial period is set for the plan price point.
Price Point Accounting Category 1Displays the name of the category of your product type price point in Xero. If you've integrated with QuickBooks, this will be the Class. Uses the format "<Category>:<Name>" for example, "Region: North".
Price Point Accounting Category 2Displays the name of the category of your product type price point in Xero. Uses the format"<Category>:<Name>" for example, "Region: North."
Price Point Billing CyclesBilling cycles are set at the product type price point level.
Displayed in CheckoutValue is True if checkout through a product type-specific URL is enabled. Value is False if otherwise.
<Per the Custom Fields name>Any custom fields created in PC 2.0 for any item, item family, or item price should be shown according to the same logic in PC 1.0.

Subscription Contract Terms

FieldDescription
Action At Term EndWhen the contract term is completed, action will be taken. Possible values are renew, evergreen, cancel, and renew_once.
Cancellation Cut-Off PeriodThe number of days before the contract end date, during which the customer is barred from canceling the contract term via the Self-Serve Portal.
Subscription IDThe ID of the subscription for which this contract term is for.
StatusStatus of the contract. Possible values are active, completed, canceled, and terminated.
Remaining Billing CyclesThe number of subscription billing cycles remaining after the current one for the contract term.
Customer IDCustomer ID associated with the contract.
Currency CodeCurrency in which the contract is set up.
Created AtDate of creation of the contract term.
Contract Start DateStart date of the contract term.
Contract IDUnique ID of the contract term.
Contract End DateEnd date of the contract term.
The number of billing cycles of the subscription that the contract term is for.
Total Contract ValueThe sum of the total of all the invoices raised as part of the contract term. For active contract terms, this is a predicted value. The value depends on the type of currency. If the subscription was imported with the contract term, then this value includes the value passed for the total_amount_raised.

Invoice Line Items

The available fields in the 'Invoice Line Items' datasource and their corresponding descriptions are listed below.

FieldDescription
Item Level Discount AmountDisplays the Item level discount in cents.
Tax RateDisplays the tax rate for the line item.
Unit AmountDisplays the unit amount of the line item.
Date FromDisplays the start date of the invoice.
Tax AmountDisplays the tax amount charged.
Tax Amount (Transaction Currency)Displays the tax amount charged for the item in the transaction currency.
Is TaxedSpecifies whether this line item is taxed or not.
Tax Exempt ReasonDisplays the reason or category due to which the line item price/amount is excluded from the taxable amount.
DescriptionDisplays the detailed description about this line item.
QuantityDisplays the quantity of the recurring item which is represented by this line item.
CurrencyThe currency code (ISO 4217 format) for the line item.
Line Item ID

Uniquely identifies a line_item. optional, string, max chars=40

Discount AmountDisplays the total discount amount.
AmountDisplays the total amount of the line item. (Typically equals to unit amount x quantity.)
Amount (Transaction Currency)Displays the total amount of the line item in the transaction currency.
Date ToDisplays the end date of the Invoice line item.
Is MeteredDisplays if metered billing is enabled or not.
Invoice DateDisplays the date when the invoice was raised.

Invoice Addresses

The available fields in the 'Invoice Addresses' datasource and their corresponding descriptions are listed below.

FieldDescription
Business Entity IDRepresents a unique business unit or brand under the organization.
Invoice IDThe invoice number. Acts as an identifier for an invoice and is typically generated sequentially.
Address TypeRepresents the type of Address. Possible Values are Shipping Address and Billing Address
First NameThe first name of the contact.
Last NameThe last name of the contact.
EmailThe email address.
CompanyThe company name.
PhoneThe phone number.
Line1Address line 1
Line2Address line 2
Line3Address line 3
CityThe name of the city.
State CodeThe ISO 3166-2 state/province code without the country prefix is currently supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
StateThe state/province name.
CountryThe billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
ZipZip or postal code. The number of characters is validated according to the rules specified here.
Validation StatusThe address verification status.
Is TaxableSpecifies whether this line item is taxed or not

Invoice Discounts

The available fields in the 'Invoice Discounts' datasource and their corresponding descriptions are listed below.

FieldDescription
DescriptionDescription for this deduction.
Discount AmountThe amount deducted. The format of this value depends on the kind of currency.
Currency CodeThe currency code (ISO 4217 format) for the invoice
Discount TypeThe type of discount that is applied to the line item. Relevant only when discounts[entity_type] is one of item_level_discount , item_level_coupon, document_level_discount, or document_level_coupon
Invoice IDThe invoice number. Acts as an identifier for an invoice and is typically generated sequentially.
Coupon IDActs as an identifier for a coupon that is associated with the invoice .
Customer IDActs as an identifier for the customer associated with the invoice.
Invoice DateThe document date is displayed on the invoice PDF. By default, it has the same value as the effective date of the action that created the invoice (subscription creation, update, or invoice creation). This date can be backdated (set to a value in the past) while performing the actions. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription or non-recurring charge is effective as of a past date. However, if the invoice is created as pending, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date.
Business Entity IDRepresents a unique business unit or brand under the organization

Credit Note Line Items

The available fields in the 'Credit Note Line Item' data source and their corresponding descriptions are listed below.

FieldDescription
CurrencyThe currency code (ISO 4217 format) for the line item.
Date ToDisplays the end date of the line item.
Credit Note DateDisplays the date the Credit Note is issued.
Unit AmountDisplays the unit amount of the line item.
Line Item IDUniquely identifies a line_item.
Tax RateDisplays the rate of tax for the line item.
Date FromDisplays the start date of the line item.
Tax Exempt ReasonThe reason or category due to which the line item price/amount is excluded from taxable amount.
Item Level Discount AmountDisplays the Item level discount.
Is TaxedSpecifies whether this line item is taxed or not.
AmountTotal amount of this line item. (Typically equals to unit amount x quantity.)
Amount (Transaction Currency)Total amount of this line item in the transaction currency.
Tax AmountDisplays the tax amount charged for the item.
Tax Amount (Transaction Currency)Displays the tax amount charged for the credit note line item in the transaction currency.
DescriptionDisplays the detailed description about the line item.
Discount AmountDisplays the total discounts for the line.
QuantityDisplays the quantity of the recurring item which is represented by this line item.

Monthly Subscription History

The available fields in the 'Monthly Subscription History' data source and their corresponding descriptions are listed below.

FieldDescription
Discount MRRThe Discount MRR associated with a specific subscription in a past time period.
Discount MRR (Transaction Currency)The Discount MRR associated with a specific subscription in a specific transaction currency.
CurrencyThe currency attached to a subscription for a given time period.
Impact StatusThe status of MRR (new/expansion/contraction etc) for a given time period.
Impact Sub statusThe sub status (upgrade/downgrade/cancellation etc) for a given time period.
MRRHistorical MRR associated with a subscription for a given period.
MRR (Transaction Currency)MRR associated with a subscription in a specific transaction currency.
Subscription StatusThe subscription status associated with a subscription (active/cancelled/trial/paused) for a given time period.
Change DateThe date of change in MRR for a subscription for a given time period.
MRR ImpactThe change in MRR between chosen points in time (Weekly, Monthly, Yearly).
ARR (Monthly)Historical ARR associated with a subscription for a given period.
Discount ARRThe Discount ARR associated with a specific subscription for a given period.
ARR ImpactThe change in ARR for a given period.

Applied Credits

The available fields in the Applied Credits data source and their corresponding descriptions are listed below.

FieldDescription
AmountDisplays the amount for the applied credit note.
Applied Credit Note IDDisplays the unique identifier for the applied credit note.
Applied Invoice IDDisplays the unique identifier for the invoice to which the credit note is applied.
CurrencyThe currency code (ISO 4217 format) of the applied credit note.
DateDisplays the date at which the credits are applied to an invoice.
Invoice IDDisplays the unique identifier of the invoice for which the credit note was initially raised.

Custom fields

Any custom field created in Chargebee will be directly available in the corresponding data source it is created in. Refer to this page for more information.

Monthly Component History

The available fields in the 'Monthly Component History' data source and their corresponding descriptions are listed below.

FieldsDefinition
ARRHistorical ARR associated with a subscription for a given period.
ARR (Transaction Currency)ARR associated with a subscription in the specified transaction currency.
Change dateThe date of change in MRR for a subscription for a given time period.
CurrencyThe currency attached to a subscription for a given time period.
Discount ARRThe Discount value is associated with a specific subscription for historic time period(yearly).
Discount ARR (Transaction Currency)Discount ARR associated with a subscription in the specified transaction currency.
Discount MRRThe Discount MRR associated with a specific subscription in a past time period.
Discount MRR (Transaction Currency)The Discount MRR associated with a specific subscription in a specific transaction currency.
Exchange RateExchange rate used for base currency conversion.
MRRHistorical MRR associated with a subscription for a given period.
MRR (Transaction Currency)MRR associated with a subscription in a specific transaction currency.
QuantityDisplays the quantity of the recurring item which is represented by this line item.
StatusDisplays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention

Additionally, we have the following metrics available in the Monthly Component History in Visual reports.

The Visual Reports feature is currently in early access. Contact Us to join the Early Adopter Program and enable this feature.

ResourceMetrics (fx)
SubscriptionsSignups
Monthly Subscription HistoryActivations, Active Paid Subscriptions, Active Subscriptions, Average Revenue per Paid Subscription, Average Revenue per Subscription, Cancellation ARR, Cancellation MRR, Cancellation MRR Rate, Downgrade ARR, Downgrade MRR, Downgrades, Expansion ARR, Expansion MRR, Free To Paid ARR, Free To Paid MRR, Free to Paid Subscriptions, Gross MRR Churn, Gross MRR Churn Rate, Lifetime Value of Paid Subscriptions, Net ARR Growth, Net MRR Churn Rate, Net MRR Growth, New ARR, New MRR
Monthly Component HistoryActivations, Active Paid Subscriptions, Active Subscriptions, Average Revenue per Paid Subscription, Average Revenue per Subscription, Overall Subscription Churn, Paid Subscription Churn, Total MRR, Total Subscription Quantity
Yearly Subscription HistoryActivations, Active Paid Subscriptions, Active Subscriptions, Average Revenue per Paid Subscription, Average Revenue per Subscription, Cancellation ARR, Cancellation MRR, Cancellation MRR Rate, Downgrade ARR, Downgrade MRR, Downgrades, Expansion ARR, Expansion MRR, Free To Paid ARR, Free To Paid MRR, Free to Paid Subscriptions, Gross MRR Churn, Gross MRR Churn Rate, Lifetime Value of Paid Subscriptions, Net ARR Growth, Net MRR Churn Rate, Net MRR Growth, New ARR, New MRR, New Paid Subscriptions, New Subscriptions, Overall Subscription Churn, Paid Subscription Churn, Paid Subscription Churn Rate, Paid Subscription Lifetime, Reactivation ARR, Reactivation MRR, Reactivations, Resumed MRR, Subscriptions Churn, Subscriptions in Trial, Total ARR, Total Churn Rate, Total MRR, Total MRR Impact, Upgrade ARR, Upgrade MRR, Upgrades
Yearly Component HistoryActivations, Active Paid Subscriptions, Active Subscriptions, Average Revenue per Paid Subscription, Average Revenue per Subscription, Overall Subscription Churn, Paid Subscription Churn, Total MRR, Total Subscription Quantity
InvoicesBilling, New Billing
PaymentsGross Cashflow
RefundsRefunds

Yearly Subscription History

The available fields in the 'Yearly Subscription History' data source and their corresponding descriptions are listed below.

FieldDescription
Discount MRR (Yearly)The Discount MRR associated with a specific subscription in a past time period.
CurrencyThe currency attached to a subscription for a given time period.
Impact StatusThe status of MRR (new/expansion/contraction etc) for a given time period.
Impact Sub statusThe sub status (upgrade/downgrade/cancellation etc) for a given time period.
MRRHistorical MRR associated with a subscription for a given period.
Subscription StatusThe subscription status associated with a subscription (active/cancelled/trial/paused) for a given time period.
Next Billing Amount (Transaction Currency)Displays the next billing amount in the specified transaction currency.
Change DateThe date of change in MRR for a subscription for a given time period.
MRR ImpactThe change in MRR between chosen points in time. (Weekly, Monthly, Yearly).
ARRHistorical ARR associated with a subscription.
ARR (Transaction Currency)ARR associated with a subscription in the specified transaction currency.
Discount ARRThe Discount value associated with a specific subscription for historic time period(yearly).
Discount ARR (Transaction Currency)Discount ARR associated with a subscription in the specified transaction currency.
ARR ImpactThe change in ARR between chosen time periods(Yearly).

Custom fields

Any custom field created in Chargebee will be directly available in the corresponding data source it is created in. Refer to this page for more information.

Monthly Component History

The available fields in the 'Monthly Component History' data source and their corresponding descriptions are listed below.

FieldsDefinition
ARRHistorical ARR associated with a subscription for a given period.
ARR (Transaction Currency)ARR associated with a subscription in the specified transaction currency.
Change dateThe date of change in MRR for a subscription for a given time period.
CurrencyThe currency attached to a subscription for a given time period.
Discount ARRThe Discount value is associated with a specific subscription for historic time period(yearly).
Discount ARR (Transaction Currency)Discount ARR associated with a subscription in the specified transaction currency.
Discount MRRThe Discount MRR associated with a specific subscription in a past time period.
Discount MRR (Transaction Currency)The Discount MRR associated with a specific subscription in a specific transaction currency.
Exchange RateExchange rate used for base currency conversion.
MRRHistorical MRR associated with a subscription for a given period.
MRR (Transaction Currency)MRR associated with a subscription in a specific transaction currency.
QuantityDisplays the quantity of the recurring item which is represented by this line item.
StatusDisplays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention

Additionally, we have the following metrics available in the Monthly Component History in Visual reports.

The Visual Reports feature is currently in early access. Contact Us to join the Early Adopter Program and enable this feature.

ActivationsNumber of subscriptions that were activated in a particular period and had a particular Plan or Addon (Recurring / Non Recurring) at the time of activation.
Active Paid SubscriptionsNumber of paid subscriptions that had their status as Active as of the analysis period and had a particular plan or Addon (Recurring / Non Recurring) as of the specific period.
Active SubscriptionsNumber of Paid / Not Paid subscriptions that had their status as Active as of a specific period and had a particular plan or Addon (Recurring / Non Recurring) as of the specific period.
Average Revenue per Paid SubscriptionTotal MRR contributed by a specific plan / Addon (Recurring / Non Recurring) per paid subscription in a specific period.
Average Revenue per subscriptionTotal MRR contributed by a specific plan / Addon (Recurring / Non Recurring) per subscription in specific period.
Overall Subscription ChurnNumber of subscriptions that were cancelled in specific period and had a specific plan / Addon (Rec
Paid Subscription ChurnTotal number of Paid Subscription cancellations.
Total MRRTotal Monthly Recurring Revenue earned from Subscription.
Total Subscription QuantityDisplays the total quantity for the subscription.

Yearly Component History

The available fields in the 'Yearly Component History' data source and their corresponding descriptions are listed below.

FieldDescription
Discount MRR (Yearly)The Discount MRR associated with a specific subscription in a past time period.
CurrencyThe currency attached to a subscription for a given time period.
Impact StatusThe status of MRR (new/expansion/contraction etc) for a given time period.
Impact Sub statusThe sub status (upgrade/downgrade/cancellation etc) for a given time period.
MRRHistorical MRR associated with a subscription for a given period.
Subscription StatusThe subscription status associated with a subscription (active/cancelled/trial/paused) for a given time period.
Next Billing Amount (Transaction Currency)Displays the next billing amount in the specified transaction currency.
Change DateThe date of change in MRR for a subscription for a given time period.
MRR ImpactThe change in MRR between chosen points in time. (Weekly, Monthly, Yearly).
ARRHistorical ARR associated with a subscription.
ARR (Transaction Currency)ARR associated with a subscription in the specified transaction currency.
Discount ARRThe Discount value associated with a specific subscription for historic time period(yearly).
Discount ARR (Transaction Currency)Discount ARR associated with a subscription in the specified transaction currency.
ARR ImpactThe change in ARR between chosen time periods(Yearly).

Additionally, we have the following metrics available in the Yearly Component History in Visual reports.

The Visual Reports feature is currently in early access. Contact Us to join the Early Adopter Program and enable this feature.

FieldsDefinition
ARRHistorical ARR associated with a subscription for a given period.
ARR (Transaction Currency)ARR associated with a subscription in the specified transaction currency.
Change dateThe date of change in MRR for a subscription for a given time period.
CurrencyThe currency attached to a subscription for a given time period.
Discount ARRThe Discount value is associated with a specific subscription for historic time period(yearly).
Discount ARR (Transaction Currency)Discount ARR associated with a subscription in the specified transaction currency.
Discount MRRThe Discount MRR associated with a specific subscription in a past time period.
Discount MRR (Transaction Currency)The Discount MRR associated with a specific subscription in a specific transaction currency.
Exchange RateExchange rate used for base currency conversion.
MRRHistorical MRR associated with a subscription for a given period.
MRR (Transaction Currency)MRR associated with a subscription in a specific transaction currency.
QuantityDisplays the quantity of the recurring item which is represented by this line item.
StatusDisplays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention

Additionally, we have the following metrics available in the Yearly Component History in Visual reports.

The Visual Reports feature is currently in early access. Contact Us to join the Early Adopter Program and enable this feature.

Metric(fx)Definition
ARRHistorical ARR associated with a subscription for a given period.
ARR (Transaction Currency)ARR associated with a subscription in the specified transaction currency.
Change dateThe date of change in MRR for a subscription for a given time period.
CurrencyThe currency attached to a subscription for a given time period.
Discount ARRThe Discount value is associated with a specific subscription for historic time period(yearly).
Discount ARR (Transaction Currency)Discount ARR associated with a subscription in the specified transaction currency.
Discount MRRThe Discount MRR associated with a specific subscription in a past time period.
Discount MRR (Transaction Currency)The Discount MRR associated with a specific subscription in a specific transaction currency.
Exchange RateExchange rate used for base currency conversion.
MRRHistorical MRR associated with a subscription for a given period.
MRR (Transaction Currency)MRR associated with a subscription in a specific transaction currency.
QuantityDisplays the quantity of the recurring item which is represented by this line item.
StatusDisplays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention

Order Line items

The available fields in the 'Order Line items' data source and their corresponding descriptions are listed below.

FieldDescription
Line item IdUniquely identifies a line_item.
Unit priceDisplays the unit price for the subscription.
DescriptionDisplays the detailed description about this order line item.
AmountDisplays the total amount of the order line item. (Typically equals to unit amount x quantity.)
Fulfillment QuantityDisplays the quantity of the recurring item which is represented in this order line item.
Fulfillment AmountDisplays the fulfillment amount of the order line item.
Tax AmountDisplays the total tax amount for the ordered line item in the transaction currency.
Amount PaidTotal amount paid for an order line item.
Amount AdjustedTotal amount adjusted for an order line item.
Refundable Credits IssuedTotal amount of refundable credits issued for an order line item.
Refundable CreditsTotal amount of credits refundable for an order line item.
Is ShippableDisplays 'Yes' if the order line item is shippable , 'No', if otherwise.
SKUDisplays the Order line item name used in your third party accounting application.
StatusDisplays the status of the order.
Entity TypeDisplays the type of order.
Discount amountDisplays the total discount amount.
Item level discount amountDisplays the Item level discount.

Metrics available within data sources in Visual reports

ResourceMetrics (fx)
SubscriptionsSignups
Monthly Subscription HistoryActivations Active Paid Subscriptions Active Subscriptions Average Revenue per Paid Subscription Average Revenue per Subscription Cancellation ARR Cancellation MRR Cancellation MRR Rate Downgrade ARR Downgrade MRR Downgrades Expansion ARR Expansion MRR Free To Paid ARR Free To Paid MRR Free to Paid Subscriptions Gross MRR Churn Gross MRR Churn Rate Lifetime Value of Paid Subscriptions Net ARR Growth Net MRR Churn Rate Net MRR Growth New ARR New MRR New Paid Subscriptions New Subscriptions Overall Subscription Churn Paid Subscription Churn Paid Subscription Churn Rate Paid Subscription Lifetime Reactivation ARR Reactivation MRR Reactivations Resumed MRR Subscriptions Churn Subscriptions in Trial Total ARR Total Churn Rate Total MRR Total MRR Impact Upgrade ARR Upgrade MRR Upgrades
Monthly Component HistoryActivations Active Paid Subscriptions Active Subscriptions Average Revenue per Paid Subscription Average Revenue per Subscription Overall Subscription Churn Paid Subscription Churn Total MRR Total Subscription Quantity
Yearly Subscription HistoryActivations Active Paid Subscriptions Active Subscriptions Average Revenue per Paid Subscription Average Revenue per Subscription Cancellation ARR Cancellation MRR Cancellation MRR Rate Downgrade ARR Downgrade MRR Downgrades Expansion ARR Expansion MRR Free To Paid ARR Free To Paid MRR Free to Paid Subscriptions Gross MRR Churn Gross MRR Churn Rate Lifetime Value of Paid Subscriptions Net ARR Growth Net MRR Churn Rate Net MRR Growth New ARR New MRR New Paid Subscriptions New Subscriptions Overall Subscription Churn Paid Subscription Churn Paid Subscription Churn Rate Paid Subscription Lifetime Reactivation ARR Reactivation MRR Reactivations Resumed MRR Subscriptions Churn Subscriptions in Trial Total ARR Total Churn Rate Total MRR Total MRR Impact Upgrade ARR Upgrade MRR Upgrades
Yearly Component HistoryActivations Active Paid Subscriptions Active Subscriptions Average Revenue per Paid Subscription Average Revenue per Subscription Overall Subscription Churn Paid Subscription Churn Total MRR Total Subscription Quantity
InvoicesBilling New Billing
PaymentsGross Cashflow
RefundsRefunds

Dunning Details

FieldDescription
Transaction HandleTransaction associated with the dunning attempt.
Dunning TypeTypes of dunning. Possible values are - auto collect, offline, direct debit.
Transaction AmountTotal amount of the transaction.
Currency CodeThe currency code of the invoice amount.
Attempt NumberDunning attempt number
Created OnThe timestamp at which the attempt was made.
Customer IDThe unique ID of the customer this invoice was created for.
Subscription IDThe unique ID of the subscription the corresponding invoice was created for.
Invoice IDThe unique ID of the invoice.

Payment Sources

The available fields in the 'Payment Sources' data source and their corresponding descriptions are listed below.

FieldDescription
Card BrandRepresent the brand of the card. Possible Values are visa, master_card, american_express, etc.
Amazon EmailThe email address associated with the Amazon payment account.
Card Funding TypeIndicates the source of funds for a card. Values include credit, debit, prepaid, not_known, and not_applicable (used for non-card methods like ACH). This helps identify the type of card used in a transaction.
Gateway Account IDThe gateway account to which the payment source is associated.
Customer HandleDisplays the customer’s unique identifier associated with the payment source.
Bank Name On AcountAccount holder’s name as per the bank account.
Card First NameAccount holder’s first name as per the bank account.
Bank Last Four DigitsThe last four digits of the bank account number.
Card Expiry YearThe expiry year of the card.
IP AddressThe IP address of the customer.
Paypal Agreement IDBilling agreement ID of PayPal.
Card Billing Address2Address line 2, as available in the card billing address.
Card IinThe Issuer Identification Number, i.e., the first six digits of the card number.
Card Billing Address 1Address line 1, as available in the card billing address.
DeletedIndicates that this resource has been deleted.
Bank Account TypeIndicates the type of bank account used for creating a payment source, mainly for Authorize.net ACH and Razorpay NetBanking. Possible values include checking, savings, business_checking, and current. Defaults to null if not provided.
Card Last Four DigitsThe last four digits of the card number
Card Billing CityCity, as available in the card billing address.
Card Billing CountryThe billing address country of the customer. It is one of ISO 3166 alpha-2 country code.
Bank Echeck TypeSpecifies the type of eCheck for Authorize.net ACH payments. Options include web (authorized online), ppd (prearranged with the customer), and ccd (requires corporate authorization, used with business checking accounts)
StatusRepresents the current state of the payment source. Possible values include valid (active), expiring (nearing expiration), expired (no longer usable), invalid (temporarily unusable), and pending_verification (awaiting confirmation). The default is valid.
Card Expiry MonthCard expiry month of the card
Card Billing ZipPostal or Zip code, as available in the card billing address.
Business Entity IDThe unique ID of the business entity of this payment_source. This is always the same as the business entity of the customer.
Card Billing State CodeThe ISO 3166-2 state/province code without the country prefix is currently supported for the USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set state_code as TN (not IN-TN). For British Columbia (Canada), set state_code as BC (not CA-BC).
Card Billing StateThe state/province name.
Card Masked NumberA masked credit card number that is safe to show.
TypeDisplays the type of payment source. The Possible values are card, paypal_express_checkout, amazon_payments, and direct_debit.
Issuing CountryTwo-letter(alpha2) ISO country code.
Bank Mandate IDBank account details of the direct debit, ACH, or NetBanking agreement/mandate created with this payment source.
Bank Account Holder TypeIndicates the account holder type. Possible values are individual and company.
Paypal EmailThe email address associated with PayPal Express Checkout.
Bank NameName of the account holder’s bank.
Card Last NameCardholder's last name.
HandleUnique Identifier of the Payment Source.
Reference IDThe reference ID. In the case of Amazon and PayPal, this will be the 'billing agreement id'. For GoCardless direct debit, this will be the 'mandate id'. In the case of card payments, this will be the identifier provided by the gateway/card vault for the specific payment method resource.
Amazon Agreement IDBilling agreement ID of Amazon Payment.
GatewayGateway specifies the payment gateway where the payment source is stored. Possible values include chargebee (Chargebee test gateway), chargebee_payments (Chargebee Payments gateway), adyen (Adyen payment gateway), and stripe (Stripe payment gateway).

Subscription Discounts

The available fields in the 'Subscription Discounts' data source and their corresponding descriptions are listed below.

FieldDescription
Subscription Discounts IDAn immutable, unique id for the discount. It is always auto-generated.
Invoice NameThe name of the discount as it should appear on customer-facing pages and documents, such as invoices and hosted pages. This is auto-generated based on the type, amount, and currency_code of the discount. For example, it can be 10% off or 10$ off.
PercentageThe percentage of the original amount that should be deducted from it.
AmountThe value of the discount. The format of this value depends on the kind of currency.
Currency CodeThe currency code (ISO 4217 format) of the discount. This is only applicable when discount.type is fixed_amount.
Duration TypeSpecifies the time duration for which this discount is attached to the subscription.
TypeThe type of discount. Possible values are: fixed_amount : *The specified amount will be given as discount.*percentage: The specified percentage will be given as discount.
Apply TillSpecifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period duration type discount.
Applied CountSpecifies the number of times the discount has been applied.
PeriodThe duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.
Period UnitThe unit of time for period. Applicable only when duration_type is limited_period.
Apply OnThe amount on the invoice to which the discount is applied.
Item Price IDThe ID of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price.
Subscription IDThe unique identifier of the subscription resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.
Creation DateTimestamp indicating when this discount was created.
Included In MRRThe discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, if the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned as false.

Subscription Addons

The available fields in the 'Subscription Addons' data source and their corresponding descriptions are listed below.

FieldDescription
Customer IDThe unique identifier of the customer resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.
Subscription IDThe unique identifier of the subscription resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier.
Addon IDActs as a unique identifier of the Subscription Addon.
QuantityThe quantity of the item purchased.
Currency CodeThe currency code (ISO 4217 format) of the subscription.
Unit PriceThe price/per unit price of the item. When not provided, the value set for the item price is used. This is only applicable when the pricing_model of the item price is flat_fee or per_unit. Also, it is only allowed when price overriding is enabled for the site. The value depends on the type of currency. If changes_scheduled_at is in the past and a unit_price is not passed, then the item price’s current unit price is considered, even if the item price did not exist on the date as of when the change is scheduled.
AmountThe total amount for the item is determined from unit_price, free_quantity, quantity, and item_tiers, as applicable. The value depends on the type of currency.
Trial EndThe date/time when the trial period of the item ends.
Remaining Billing CyclesDenotes the number of subscription billing cycles for which the addon is included.
Business Entity IDRepresents a unique business unit or brand under the organization.

Was this article helpful?