Getting Started

Product Catalog

Customers

Subscriptions

Invoices, Credit Notes, and Quotes

Taxes

Payments

Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics

Integrations

Data Sources 

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

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

Coupons 

The available fields in the ‘Coupons' datasource and their corresponding descriptions are listed below.

Field Description
Currency The currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons alone.
Duration Type Displays if the coupon can be used one_time, forever, or for a limited_period.
Redemptions Displays the the number of times a coupon was redeemed.
Created On Timestamp indicating when this coupon was created.
Valid Till Displays the date until which the coupon can be applied to new subscriptions.
Coupon ID Displays the unique identifier for the coupon.
Addon Applicability Displays if the coupon can be applied to add-ons. Possible values are none, all, specific, not_applicable.
Maximum Redemptions Displays the maximum number of times the coupon can be redeemed.
Duration Displays the duration in months for the coupon to be applied. Applicable only for limited period coupon.
Apply On Displays the invoice items for which this discounts need to be applied. Possible values are invoice_amount, each_specified_item.
Name Displays the coupon name.
Archived On Timestamp indicating when this coupon was archived.
Invoice Name Displays the invoice name of the coupon.
Discount Percentage Displays the discount value in percentage.
Status Displays the status of the coupon. Possible values are active, expired, archived, deleted.
Discount Type Specifies the time duration this coupon is applicable. Possible values are one_time, forever, limited_period.
Plan Applicability Displays if the coupon can be applied to plans. Possible values are none, all, specific, not_applicable.
Discount Amount Displays the discount value in dollars.

Credit Notes 

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

Field Description
Voided On Timestamp indicating the date & time the credit note got voided.
Credit Note ID Displays the unique identifier of the credit note.
Amount Refunded Displays the refunds issued from the Credit Note.
Round Off Amount Displays the rounded-off amount.
Amount Allocated Displays the total credits allocated to invoices.
VAT Number Displays the VAT number of the customer for whom this Credit Note is raised.
Price Type Displays the price type of the Credit Note.
Reason Code Displays 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 Credits Displays the credits that are yet to be used from the credit note.
Credit Note Status Displays the status of the credit note. Possible values are adjusted, refunded, refund_due, voided.
Sub Total Displays the sub total of the credit note.
Created On Displays the date when the Credit Note was issued.
Type Displays the type of the credit note. Possible options are Adjustment and Refundable.
Refunded On Displays the time when credits were completely used or refunded.
Total Credit Note amount in dollars.
Currency The currency code (ISO 4217 format) for the credit note.

Customers 

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

Field Description
Currency The currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons alone.
Duration Type Displays if the coupon can be used one_time, forever, or for a limited_period.
Redemptions Displays the the number of times a coupon was redeemed.
Created On Timestamp indicating when this coupon was created.
Valid Till Displays the date until which the coupon can be applied to new subscriptions.
Coupon ID Displays the unique identifier for the coupon.
Addon Applicability Displays if the coupon can be applied to add-ons. Possible values are none, all, specific, not_applicable.
Maximum Redemptions Displays the maximum number of times the coupon can be redeemed.
Duration Displays the duration in months for the coupon to be applied. Applicable only for limited period coupon.
Apply On Displays the invoice items for which this discounts need to be applied. Possible values are invoice_amount, each_specified_item.
Name Displays the coupon name.
Archived On Timestamp indicating when this coupon was archived.
Invoice Name Displays the invoice name of the coupon.
Discount Percentage Displays the discount value in percentage.
Status Displays the status of the coupon. Possible values are active, expired, archived, deleted.
Discount Type Specifies the time duration this coupon is applicable. Possible values are one_time, forever, limited_period.
Plan Applicability Displays if the coupon can be applied to plans. Possible values are none, all, specific, not_applicable.
Discount Amount Displays the discount value in dollars.

In addition to the fields listed above, the ‘Customers' data source also contains the following custom fields.

  • Business Type
  • Business Vertical
  • Acquisition Cost
  • Acquisition Channel
  • Acquisition Mode
  • Sales Agent
  • Customer Type
  • Account Manager
  • Customer Success Agent
  • Solution Partner

Invoices 

The available fields in the ‘Invoices' datasource and their corresponding descriptions are listed below.

Field Description
Expected Payment Date Displays the expected payment date recorded for the invoice.
Paid On Timestamp indicating the date & time when the invoice was paid.
Invoice ID Displays the unique identifier of the invoice.
First Invoice Displays 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 Collect Displays the rounded-off invoice amount.
Net D Displays the number of days within which the invoice has to be paid.
Next Retry On Timestamp indicating when will the next attempt to collect payment for the invoice will occur.
Dunning Status Displays the dunning status of the invoice. Possible values are in_progress, exhausted, stopped, success.
Currency The currency code (ISO 4217 format) of the invoice amount.
Total Tax Amount Displays the total tax amount for the invoice.
Write Off Amount Displays the amount written off against the invoice.
Is Recurring Invoice Displays ‘Yes' if the invoice is a recurring, ‘No', if otherwise.
Amount Due Displays the total amount to be collected. This includes invoice's payments in progress.
Amount Adjusted Displays the total adjustments made against the invoice.
Round Off Amount Indicates the rounded-off amount.
Amount Paid Displays the total payments received for the invoice.
Advance Charges Boolean indicating any advance charge is present in this invoice.
Credits Applied Displays the total credits applied against the invoice.
Issued On Closing date of the invoice. Typically this is the date on which invoice is generated. If you have "wait & notify to send invoices enabled for usage based billing" , then the date displayed here will be different.
Due Date Displays the invoice Due Date.
Price Type The price type of the invoice. Possible values are tax_exclusive, tax_inclusive.
Status Displays the current status of this invoice. Possible values are paid, posted, payment_due, not_paid, voided, pending.
Total Invoiced amount in dollars.
Po Number Displays the Purchase Order Number for this invoice.
VAT Number Displays the Vat Number.
Sub Total Displays the Sub total of the invoice.
Voided On Timestamp indicating the date & time the invoice got voided.

Orders 

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

Field Description
Order ID Unique identifier of an order.
Document Number Serial number of an order.
Status Current status of an order.
Reason Code Reason for an order cancellation.
Payment Status Indicates if the payment for an order is in a *Paid* or *Not Paid* status.
Order Type Indicates if an order type is *Manual* or *System generated*.
Price Type Indicates if the price of an order is *Inclusive* or *Exclusive* of tax.
Reference ID An ID used to refer to an order in a third-party application.
Fulfillment Status Status of an order in a third-party application.
Note Custom note added for an order.
Tracking ID An ID that is used to track the status of an order.
Batch ID An ID that is used to identify a group of orders.
Created By The source of order creation.
Shipment Carrier Details of the Shipment Carrier.
Currency Currency code of an invoice in ISO 4217 format.
Invoice Round Off Amount Total round off amount of an order's invoice.
Tax Amount Total tax amount of an order.
Amount Paid Total amount paid for an order.
Amount Adjusted Total amount adjusted for an order.
Refundable Credits Issued Total amount of refundable credits issued for an order.
Refundable Credits Total amount of credits refundable for an order.
Rounding Adjustment Provides 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 Date The date when the order was placed.
Shipping Date This is the date on which the order is/has to be shipped.
Paid On Date and time of invoice payment for an order.
Shipping Cut Off Date The time after which an order becomes unserviceable. need info
Created On Date and time when the order was created.
Last Status Update At Date and time of the last order update.
Delivered On Date and time of order delivery.
Shipping On Date and time of order shipment.
Canceled On Date and time when the order was cancelled.
Discount Amount Total amount of discount provided for an order.
Sub Total Sub total amount of an order.
Total Total amount charged for an order.
Is Gifted Indicates if the order is a gift or not.

Payments 

The available fields in the ‘Payments' datasource and their corresponding descriptions are listed below.

Field Description
Fraud Flag Indicates whether or not the transaction has been identified as fraudulent. Possible values are safe, suspicious,fraudulent.
Gateway Transaction ID Displays the ID with which this transaction is referred by the gateway.
Gateway Account ID Displays the gateway used for the transaction.
Masked Card Number Displays the masked card number used for the transaction. Applicable only for 'Card' Payment Method.
Capturable Amount Displays the unused but authorized amount present for this transaction. Applicable only for Authorization transactions.
Unused Amount Displays the unused amount present for this transaction. Applicable only for Payments.
Authorization Reason Code TDisplays the type of authorization. Possible values are blocking_funds, verification.
Settled On Displays the time at which the final status of the transaction has been marked.
Reference Authorization ID Displays the original authorization transaction id that got captured. Applicable only for payment transactions.
Transaction Amount Displays the amount for the transaction.
Reversal Transaction ID Displays the reversal transaction id. Applicable only for payment transactions.
Voided On Timestamp indicating when the payment was voided or authorization expired at gateway.
Payment Gateway Gateway through which this transaction was done. Applicable only for 'Card' Payment Method.
Error Code Displays the Error code received from the payment gateway on failure.
Status Displays the status of this transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention.
Currency The currency code (ISO 4217 format) for the transaction.
Reference Number Displays the reference number for the transaction. e.g check number in case of 'check' payments.
Type Displays the type of the transaction. Possible values are authorization, payment, refund, payment_reversal.
Transaction Date Indicates when this transaction occurred.
Fraud Reason Displays the description why the transaction was marked as fraud/suspicious.
Transaction ID Displays the transaction ID.
Payment Method Displays 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.

Field Description
Plan Name The display name of the plan.
Plan Period Displays the period of the plan.
SKU Displays the Product name/code used in your third party accounting application.
Price The price of the plan.
Account Code Displays the Account code of the plan used for integration purposes.
Invoice Name Displays the invoice name.
Plan Currency The currency code (ISO 4217 format) of the plan.
Free Quantity Displays the number of free units.
Pricing Model Displays the pricing model.
Tax Code Displays the tax code in case of Avlara integration.
Trial Period Unit Displays the unit for the trial period. Possible values are day and month.
Enabled in Self-Serve Portal Displays ‘Yes' if the customers can change their subscription using the self serve portal. Displays ‘No', if otherwise.
Taxable Displays ‘Yes' if the plan is taxable, ‘No', if otherwise.
Status Displays the status of the plan. Possible values are active, archived.
Charge Type Displays if the charges are recurring, or non-recurring.
Plan Setup Fee Displays the one time set up free.
Trial Period Displays the trial period for the plan/add-on.
Product Type Displays if the product type is a plan or add-on.
Accounting Category 1 Displays 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 2 Displays the name of the category of your product in Xero. Uses the format<Category>:<Name>". E.g. "Region: North".
Billing Cycles The number of billing cycles the subscription is active.
Billing Frequency Unit Defines billing frequency in association with billing period. Possible values are week, month, year.
Enabled in Hosted Pages Displays True if checkout through plan specific URL is enabled. Displays False if otherwise.

In addition to the fields listed above, the ‘Product' data source also contains the following custom fields.

  • Plan Group

Refunds 

The available fields in the ‘Refunds' datasource and their corresponding descriptions are listed below.

Field Description
Currency The currency code (ISO 4217 format) for the transaction.
Amount Displays the amount refunded for the transaction.
Status Displays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention
Transaction ID Displays the transaction ID.
Settled On Indicates the time at which the final status of the transaction has been marked.
Gateway Account ID Displays the gateway account used for the transaction.
Payment Method Displays 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 Date Indicates when this transaction occurred.
Fraud Flag Indicates whether or not the transaction has been identified as fraudulent. Possible values are safe, suspicious, fraudulent.
Type Displays the type of the transaction. Possible values are authorization, payment, refund, payment_reversal.
Payment Gateway Displays the gateway through which the transaction was done. Applicable only for 'Card' Payment Method. Possible values are chargebee, stripe, wepay, braintree, authorize_net, paypal_pro, pin, eway, eway_rapid, worldpay, balanced_payments, beanstream, bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, wirecard, amazon_payments, paypal_express_checkout, gocardless, adyen, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, not_applicable.
Masked Card Number Displays the masked card number used for the refund transaction. Applicable only for 'Card' Payment Method.
Reference Number Displays the reference number for the transaction. e.g check number in case of 'check' payments.
Voided On Timestamp indicating when the payment was voided or authorization expired at gateway.
Gateway Transaction ID Displays the ID with which this transaction is referred in gateway.
Reference Payment ID Displays the reference payment ID. Applicable only for refund and reversal transactions.
Error Code Displays the Error code received from the payment gateway on failure.
Fraud Reason Displays thereason why the transaction was marked as fraud/suspicious.

Subscriptions 

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

Canceled On Time at which subscription was cancelled or is set to be cancelled.
Reason Code Reason 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 Quantity Displays the plan quantity for the subscription.
Currency The currency code (ISO 4217 format) of the subscription.
Subscription Billing Period Displays the billing period for the subscription
Current Plan The name of the current plan associated with a subscription.
Recurring Discount MRR Recurring discount amount associated with a subscription.
Current Billing Term Start Date Start of the current billing term.
Auto-Collection Defines 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 End End 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 Frequency Displays the billing period of the subscription.
Total Amount Due Total 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 On Time at which the subscription moved from 'In_trial' state to 'Active' state.
Next Billing On The next billing date.
Due Invoices Total 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 ID Unique identifier for a subscription.
Created From IP Address The IP address of the user. (Primarly used by refersion integration to track/log affiliate subscription.)
Initial Plan Name The name of the first plan associated with a subscription.
Subscription Start Date Displays the subscription start date. Will be null for 'future' subscriptions as it is yet to be started.
Subscription Status Current status of the subscription.
Currency The currency code (ISO 4217 format) of the subscription.
Remaining Billing Cycles The total number of billing cycles for the subscription.
Current Billing Term End Date End date of the current billing term.
Current Plan Unit Price Displays the unit price for the subscription. (In case the price is overrided, then that amount will be displayed)
Trial Period Start Date Start 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 Source Unique identifier of the payment method attached to the subscription.
Current Subscription Plan Free Quantity Displays the number of free units for the subscription
Due Since Displays 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 Date The start date for future subscription.
Initial Active Plan The name of the first active plan associated with a subscription.
Created On Subscription created time.
PO Number Purchase Order Number for the invoice.
Current Subscription Setup Fee The set up accosiated with the subscription.
Scheduled Changes Displays true if there are changes scheduled for the next renewal.
Current MRR Displays the current monthly recurring revenue of the subscription.
Committed CMRR (Monthly Recurring Revenue) Displays the committed monthly recurring revenue for future period.
Discount CMRR (Committed Monthly Recurring Revenue) Displays the committed monthy recurring discount amount.

In addition to the fields listed above, the ‘Subscriptions' data source also contains the following custom fields.

  • Sales Agent
  • Acquisition Cost
  • Solution Partner
Was this article helpful?
Loading…