Docs
You are viewing:
Product Catalog 2.0
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 has multiple fields.
Note
The Report Builder allows you to create reports using the following 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.
The available fields in the ‘Coupons' data source 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 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. |
The available fields in the ‘Credit Notes' data source 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. |
| Total(Transaction Currency) | Credit Note amount in the transaction currency. |
| Currency | The currency code (ISO 4217 format) for the credit note. |
The available fields in Customers and their corresponding descriptions are listed below.
Field | Description |
|---|---|
Account Manager | The internal team member (usually a sales or customer success rep) is responsible for managing the relationship with this customer. Useful for tracking ownership and accountability. |
Acquisition Channel | Indicates the channel through which the customer was acquired. |
Acquisition Cost | The monetary cost incurred to acquire the customer (also known as CAC – Customer Acquisition Cost). |
Acquisition Currency | The currency in which the acquisition cost was recorded. |
Acquisition Mode | Describes the method or journey by which the customer was acquired. |
Allow Direct Debit | It indicates whether the customer can pay via Direct Debit. |
Auto-Collection | When the customer has a payment_method of type card, this attribute determines whether to automatically charge the card whenever an invoice status is payment_due. |
Billing Day of Week | Billing Day of Mont’s day. Possible values are Sunday , Monday … Saturday. |
Business Type | Refers to the legal or operational structure of a customer’s organization. |
Business Vertical | Refers to the industry or sector the customer operates in. |
Channel | Specifies where the subscription was created and how it's managed.
|
Company | The company name. |
Consolidated Invoicing | Indicates whether invoices raised on the same day for the customer are consolidated. When present, this value overrides the default configuration at the site-level. This attribute is applicable only when Consolidated Invoicing is enabled. |
Country | The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. |
Created From IP Address | The IP address of the customer when this customer record was created. It’s mainly used for referral integrations and validating VAT if the customer is in the EU or UK. |
Creation Date | Timestamp indicating when this customer resource was created. |
Customer ID | The unique identifier of the customer resource. |
Customer Success Agent | The person responsible for post-sale relationship, renewals, and overall customer health. |
Customer Type | The customer_type is an optional, enumerated string used only when Chargebee's AvaTax for Communications integration is enabled. It indicates the Avalara customer type and can be one of the following: residential (individual user), business (a business entity), senior_citizen (an individual eligible for senior citizen tax benefits), or industrial (an industrial business). |
The email of the customer. Configured email notifications will be sent to this email. | |
Exempt Category | This indicates the exemption information. The customer can customize customer exemptions based on a specific Location, Tax level (Federal, State, County, and Local), Category of Tax, or Tax Name. |
Exemption Number | Any string value that will cause the sale to be exempted. Use this if your finance team manually verifies and tracks exemption certificates. Applicable if you use Chargebee's AvaTax for Sales integration. |
First Name | First name of the customer. |
Fraud Flag | The fraud_flag is an optional, enumerated string field that indicates a customer's fraud status. It can take one of three values: safe, suspicious, or fraudulent. A value of safe means the customer has been explicitly marked as trustworthy. The suspicious status indicates that the payment gateway has identified the customer as potentially fraudulent. Finally, fraudulent signifies that the customer has been confirmed and marked as fraudulent. This field is useful for risk assessment and determining how to handle customer interactions based on their fraud status. |
Last Name | Last name of the customer. |
Locale | Determines which region-specific language Chargebee uses to communicate with the customer. In the absence of the locale attribute, Chargebee will use your site's default language for customer communication. |
Net D | The number of days within which the customer has to make payment for the invoice. |
Offline Payment method | The offline_payment_method is an optional, enumerated string field that specifies the customer's preferred offline payment method. It can take one of the following values: no_preference, indicating the customer has no specific preference; cash, for payments made in cash; check, for payments made via check; and bank_transfer, for payments made through a bank transfer. This field helps businesses understand and accommodate the customer's preferred method of offline payment. |
Phone | Phone number of the customer. |
Primary Payment Source ID | The identifier of the customer's primary payment source. |
Product Usage | An indicator of how much or how often the customer is using the product. |
Sales Agent | The individual from the sales team who closed or influenced the deal. |
Secondary Payment Source ID | The identifier of the customer's backup payment source. |
Solution Partner | Indicate which solution partner (if any) was associated with the acquisition or servicing of the end customer. |
State | Indicates the State or Province |
Taxable | Specifies if the customer is liable for tax |
VAT Number | The customer's VAT/tax registration number. For customers with billing_address country as XI (which is United Kingdom—Northern Ireland), the first two characters of the full VAT number can be overridden by setting vat_number_prefix. |
| Field | Description |
|---|---|
| Promotional Credits | Displays the promotional credits balance of the customer. |
| Unbilled Charges | Displays the total unbilled charges for the customer. |
| Refundable Credits | Displays the refundable credits balance of the customer. |
| Excess Payments | Displays the total unused payments associated with the customer. |
| Currency | The currency code (ISO 4217 format) of the coupon. |
The available fields in the ‘Invoices' data source 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. |
| Tax Amount (Transaction Currency) | Displays the total tax amount for the invoice in the transaction currency. |
| Write Off Amount | Displays the amount written off against the invoice. |
| Is Recurring Invoice | Displays ‘Yes' if the invoice is 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. |
| Total (Transaction Currency) | Invoiced amount in the transaction currency. |
| 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. |
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. |
| Total (Transaction Currency) | Total amount charged in transaction currency for an order. |
| Is Gifted | Indicates if the order is a gift or not. |
Shipping First Name | First Name of the contact person to which the order is shipped. |
Shipping Last Name | Last Name of the contact person to which the order is shipped. |
Shipping Address Line 1 | This is the line 1 of the Address to which the order is shipped. |
Shipping Address Line 2 | This is the line 2 of the Address to which the order is shipped. |
Shipping City | This is the city to which the order is/has to be shipped. |
Shipping State Code | This is the state co de of the state to w hich the order is to be shipped. |
Shipping State | This is the state to which the order is to be shipped. |
Shipping Zip Code | This is the Zip code to which the order is to be shipped. |
Shipping Country | This is the Country to which the order is to be shipped. |
Shipping Address Validation Status | This is the status of validation of the address to which the order
is to be shipped. |
The available fields in the ‘Payments' data source 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. |
| Amount | Displays the amount for the transaction. |
| Amount (Transaction Currency) | Displays the amount in the specified transaction currency for the payment. |
| 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. |
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 Avalara 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. |
The available fields in the ‘Refunds' data source 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. |
| Amount (Transaction Currency) | Displays the amount in the specified transaction currency for the refund. |
| 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, 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 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 the reason why the transaction was marked as fraud/suspicious. |
The available fields in Subscriptions and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| 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. (Primarily 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 overridden, 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 associated 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. |
| 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 invoices | Generate 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 method | Displays the preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit. |
| Free period | Displays the period for which the subscription is free-of-charge. |
| Free period unit | Defines additional free period in association with the billing period. |
| Auto close invoices | Set 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 Date | When 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 date | For 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 date | This 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. |
Field | Description |
|---|---|
Entity ID | Unique ID of the entity. |
Entity Name | Name of the entity. |
Field Name | Description |
Product Family Name | Name of Product family. |
Product Family ID | ID of the Product family. |
Product Type | |
Product Group | Custom field mapped to any column like plans, addons, or charges. |
Internal Product Name | The internal name is provided to identify product type plans, addons, or charges. |
External Product Name | Reference used by Chargebee to identify product type plans, addons, or charges. |
Product ID | ID of the particular product type plans, addons, or charges. |
External Price Point Name | External name is used for display in invoices, quotes, checkout, and the self-serve portal. |
Internal Price Point Name | The internal name is provided to identify a product type price point. |
Price Point ID | Reference used by Chargebee to identify this plan price point. |
Price Point Billing Frequency | Frequency of billing of a product type price point (For example. Every three months) |
Price Point Period | Number of months/years/days of a particular product type price point |
Price Point SKU | The Product name/code used in third-party accounting applications. |
Metered Product Type | A boolean field displaying if a product type is metered or not. |
Product Type Price Point | Actual 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 Code | The account code of the plan price point is used for integration purposes. |
Price Point Accounting Class | The account code of the plan price point is used for integration purposes. |
Price Point Currency | Currency set for a particular plan price point. |
Price Point Free Quantity | Free quantity set for a particular plan price point |
Price Point Pricing Model | Pricing 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 Portal | Value is True if checkout through a product type-specific URL is enabled. Value is False otherwise. |
Taxable Price Point | The value is Yes if the product type price point is taxable, or No otherwise. |
Product Type Status | The status of the product type. Possible values are active and archived. |
Product Price Point Status | The status of the product type price point. Possible values are active and archived. |
Charge Type | Displays 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 Unit | The unit for the trial period for a particular product type price point. Possible values are day and month. |
Price Point Trial Period | The trial period is set for the plan price point. |
Price Point Accounting Category 1 | Displays 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 2 | Displays 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 Cycles | Billing cycles are set at the product type price point level. |
Displayed in Checkout | Value 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. |
| Field | Description |
|---|---|
Action At Term End | When the contract term is completed, action will be taken. Possible values are renew, evergreen, cancel, and renew_once. |
Cancellation Cut-Off Period | The 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 ID | The ID of the subscription for which this contract term is for. |
Status | Status of the contract. Possible values are active, completed, canceled, and terminated. |
Remaining Billing Cycles | The number of subscription billing cycles remaining after the current one for the contract term. |
Customer ID | Customer ID associated with the contract. |
Currency Code | Currency in which the contract is set up. |
Created At | Date of creation of the contract term. |
Contract Start Date | Start date of the contract term. |
Contract ID | Unique ID of the contract term. |
Contract End Date | End date of the contract term. |
Contract Billing Cycle | The number of billing cycles of the subscription that the contract term is for. |
Total Contract Value | The 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. |
The available fields in the ‘Invoice Line Items' datasource and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Item Level Discount Amount | Displays the Item level discount in cents. |
| Tax Rate | Displays the tax rate for the line item. |
| Unit Amount | Displays the unit amount of the line item. |
| Date From | Displays the start date of the invoice. |
| Tax Amount | Displays the tax amount charged. |
| Tax Amount (Transaction Currency) | Displays the tax amount charged for the item in the transaction currency. |
| Is Taxed | Specifies whether this line item is taxed or not. |
| Tax Exempt Reason | Displays the reason or category due to which the line item price/amount is excluded from the taxable amount. |
| Description | Displays the detailed description about this line item. |
| Quantity | Displays the quantity of the recurring item which is represented by this line item. |
| Currency | The currency code (ISO 4217 format) for the line item. |
| Line Item ID | Uniquely identifies a line_item. optional, string, max chars=40 |
| Discount Amount | Displays the total discount amount. |
| Amount | Displays 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 To | Displays the end date of the Invoice line item. |
| Is Metered | Displays if metered billing is enabled or not. |
| Invoice Date | Displays the date when the invoice was raised. |
The available fields in the ‘Invoice Addresses' datasource and their corresponding descriptions are listed below.
Field | Description |
|---|---|
Business Entity ID | Represents a unique business unit or brand under the organization. |
Invoice ID | The invoice number. Acts as an identifier for an invoice and is typically generated sequentially. |
Address Type | Represents the type of Address. Possible Values are Shipping Address and Billing Address |
First Name | The first name of the contact. |
Last Name | The last name of the contact. |
The email address. | |
Company | The company name. |
Phone | The phone number. |
Line1 | Address line 1 |
Line2 | Address line 2 |
Line3 | Address line 3 |
City | The name of the city. |
State Code | The 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). |
State | The state/province name. |
Country | The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. |
Zip | Zip or postal code. The number of characters is validated according to the rules specified here. |
Validation Status | The address verification status. |
Is Taxable | Specifies whether this line item is taxed or not |
The available fields in the ‘Invoice Discounts' datasource and their corresponding descriptions are listed below.
Field | Description |
|---|---|
Description | Description for this deduction. |
Discount Amount | The amount deducted. The format of this value depends on the kind of currency. |
Currency Code | The currency code (ISO 4217 format) for the invoice |
Discount Type | The 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 ID | The invoice number. Acts as an identifier for an invoice and is typically generated sequentially. |
Coupon ID | Acts as an identifier for a coupon that is associated with the invoice . |
Customer ID | Acts as an identifier for the customer associated with the invoice. |
Invoice Date | The 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 ID | Represents a unique business unit or brand under the organization |
The available fields in the ‘Credit Note Line Item' data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Currency | The currency code (ISO 4217 format) for the line item. |
| Date To | Displays the end date of the line item. |
| Credit Note Date | Displays the date the Credit Note is issued. |
| Unit Amount | Displays the unit amount of the line item. |
| Line Item ID | Uniquely identifies a line_item. |
| Tax Rate | Displays the rate of tax for the line item. |
| Date From | Displays the start date of the line item. |
| Tax Exempt Reason | The reason or category due to which the line item price/amount is excluded from taxable amount. |
| Item Level Discount Amount | Displays the Item level discount. |
| Is Taxed | Specifies whether this line item is taxed or not. |
| Amount | Total 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 Amount | Displays 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. |
| Description | Displays the detailed description about the line item. |
| Discount Amount | Displays the total discounts for the line. |
| Quantity | Displays the quantity of the recurring item which is represented by this line item. |
The available fields in the ‘Monthly Subscription History' data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Discount MRR | The 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. |
| Currency | The currency attached to a subscription for a given time period. |
| Impact Status | The status of MRR (new/expansion/contraction etc) for a given time period. |
| Impact Sub status | The sub status (upgrade/downgrade/cancellation etc) for a given time period. |
| MRR | Historical MRR associated with a subscription for a given period. |
| MRR (Transaction Currency) | MRR associated with a subscription in a specific transaction currency. |
| Subscription Status | The subscription status associated with a subscription (active/cancelled/trial/paused) for a given time period. |
| Change Date | The date of change in MRR for a subscription for a given time period. |
| MRR Impact | The change in MRR between chosen points in time (Weekly, Monthly, Yearly). |
| ARR (Monthly) | Historical ARR associated with a subscription for a given period. |
| Discount ARR | The Discount ARR associated with a specific subscription for a given period. |
| ARR Impact | The change in ARR for a given period. |
The available fields in the Applied Credits data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Amount | Displays the amount for the applied credit note. |
| Applied Credit Note ID | Displays the unique identifier for the applied credit note. |
| Applied Invoice ID | Displays the unique identifier for the invoice to which the credit note is applied. |
| Currency | The currency code (ISO 4217 format) of the applied credit note. |
| Date | Displays the date at which the credits are applied to an invoice. |
| Invoice ID | Displays the unique identifier of the invoice for which the credit note was initially raised. |
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.
The available fields in the ‘Monthly Component History' data source and their corresponding descriptions are listed below.
Fields | Definition |
|---|---|
ARR | Historical ARR associated with a subscription for a given period. |
ARR (Transaction Currency) | ARR associated with a subscription in the specified transaction currency. |
Change date | The date of change in MRR for a subscription for a given time period. |
Currency | The currency attached to a subscription for a given time period. |
Discount ARR | The 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 MRR | The 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 Rate | Exchange rate used for base currency conversion. |
MRR | Historical MRR associated with a subscription for a given period. |
MRR (Transaction Currency) | MRR associated with a subscription in a specific transaction currency. |
Quantity | Displays the quantity of the recurring item which is represented by this line item. |
Status | Displays 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.
Metric (fx) | Definition |
|---|---|
Activations | Number 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 Subscriptions | Number 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 Subscriptions | Number 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 Subscription | Total MRR contributed by a specific plan / Addon (Recurring / Non Recurring) per paid subscription in a specific period. |
Average Revenue per subscription | Total MRR contributed by a specific plan / Addon (Recurring / Non Recurring) per subscription in specific period. |
Overall Subscription Churn | Number of subscriptions that were cancelled in specific period and had a specific plan / Addon (Rec |
Paid Subscription Churn | Total number of Paid Subscription cancellations. |
Total MRR | Total Monthly Recurring Revenue earned from Subscription. |
Total Subscription Quantity | Displays the total quantity for the subscription. |
The available fields in the ‘Yearly Subscription History' data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Discount MRR (Yearly) | The Discount MRR associated with a specific subscription in a past time period. |
| Currency | The currency attached to a subscription for a given time period. |
| Impact Status | The status of MRR (new/expansion/contraction etc) for a given time period. |
| Impact Sub status | The sub status (upgrade/downgrade/cancellation etc) for a given time period. |
| MRR | Historical MRR associated with a subscription for a given period. |
| Subscription Status | The 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 Date | The date of change in MRR for a subscription for a given time period. |
| MRR Impact | The change in MRR between chosen points in time. (Weekly, Monthly, Yearly). |
| ARR | Historical ARR associated with a subscription. |
| ARR (Transaction Currency) | ARR associated with a subscription in the specified transaction currency. |
| Discount ARR | The 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 Impact | The change in ARR between chosen time periods(Yearly). |
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.
The available fields in the ‘Monthly Component History' data source and their corresponding descriptions are listed below.
Fields | Definition |
|---|---|
ARR | Historical ARR associated with a subscription for a given period. |
ARR (Transaction Currency) | ARR associated with a subscription in the specified transaction currency. |
Change date | The date of change in MRR for a subscription for a given time period. |
Currency | The currency attached to a subscription for a given time period. |
Discount ARR | The 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 MRR | The 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 Rate | Exchange rate used for base currency conversion. |
MRR | Historical MRR associated with a subscription for a given period. |
MRR (Transaction Currency) | MRR associated with a subscription in a specific transaction currency. |
Quantity | Displays the quantity of the recurring item which is represented by this line item. |
Status | Displays 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.
Metric (fx) | Definition |
|---|---|
Activations | Number 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 Subscriptions | Number 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 Subscriptions | Number 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 Subscription | Total MRR contributed by a specific plan / Addon (Recurring / Non Recurring) per paid subscription in a specific period. |
Average Revenue per subscription | Total MRR contributed by a specific plan / Addon (Recurring / Non Recurring) per subscription in specific period. |
Overall Subscription Churn | Number of subscriptions that were cancelled in specific period and had a specific plan / Addon (Rec |
Paid Subscription Churn | Total number of Paid Subscription cancellations. |
Total MRR | Total Monthly Recurring Revenue earned from Subscription. |
Total Subscription Quantity | Displays the total quantity for the subscription. |
The available fields in the ‘Yearly Component History' data source and their corresponding descriptions are listed below.
Fields | Definition |
|---|---|
ARR | Historical ARR associated with a subscription for a given period. |
ARR (Transaction Currency) | ARR associated with a subscription in the specified transaction currency. |
Change date | The date of change in MRR for a subscription for a given time period. |
Currency | The currency attached to a subscription for a given time period. |
Discount ARR | The 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 MRR | The 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 Rate | Exchange rate used for base currency conversion. |
MRR | Historical MRR associated with a subscription for a given period. |
MRR (Transaction Currency) | MRR associated with a subscription in a specific transaction currency. |
Quantity | Displays the quantity of the recurring item which is represented by this line item. |
Status | Displays 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 |
|---|---|
ARR | Historical ARR associated with a subscription for a given period. |
ARR (Transaction Currency) | ARR associated with a subscription in the specified transaction currency. |
Change date | The date of change in MRR for a subscription for a given time period. |
Currency | The currency attached to a subscription for a given time period. |
Discount ARR | The 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 MRR | The 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 Rate | Exchange rate used for base currency conversion. |
MRR | Historical MRR associated with a subscription for a given period. |
MRR (Transaction Currency) | MRR associated with a subscription in a specific transaction currency. |
Quantity | Displays the quantity of the recurring item which is represented by this line item. |
Status | Displays the status of the transaction. Possible values are in_progress, success, voided, failure, timeout, needs_attention |
The available fields in the ‘Order Line items' data source and their corresponding descriptions are listed below.
Field | Description |
|---|---|
Line item Id | Uniquely identifies a line_item. |
Unit price | Displays the unit price for the subscription. |
Description | Displays the detailed description about this order line item. |
Amount | Displays the total amount of the order line item. (Typically equals to unit amount x quantity.) |
Fulfillment Quantity | Displays the quantity of the recurring item which is represented in this order line item. |
Fulfillment Amount | Displays the fulfillment amount of the order line item. |
Tax Amount | Displays the total tax amount for the ordered line item in the transaction currency. |
Amount Paid | Total amount paid for an order line item. |
Amount Adjusted | Total amount adjusted for an order line item. |
Refundable Credits Issued | Total amount of refundable credits issued for an order line item. |
Refundable Credits | Total amount of credits refundable for an order line item. |
Is Shippable | Displays ‘Yes' if the order line item is shippable , ‘No', if otherwise. |
SKU | Displays the Order line item name used in your third party accounting application. |
Status | Displays the status of the order. |
Entity Type | Displays the type of order. |
Discount amount | Displays the total discount amount. |
Item level discount amount | Displays the Item level discount. |
Resource | Metrics (fx) |
|---|---|
Subscriptions | Signups |
Monthly Subscription History | Activations 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 History | Activations 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 History | Activations 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 History | Activations 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 |
Invoices | Billing New Billing |
Payments | Gross Cashflow |
Refunds | Refunds |
Field | Description |
|---|---|
Transaction Handle | Transaction associated with the dunning attempt. |
Dunning Type | Types of dunning. Possible values are - auto collect, offline, direct debit. |
Transaction Amount | Total amount of the transaction. |
Currency Code | The currency code of the invoice amount. |
Attempt Number | Dunning attempt number |
Created On | The timestamp at which the attempt was made. |
Customer ID | The unique ID of the customer this invoice was created for. |
Subscription ID | The unique ID of the subscription the corresponding invoice was created for. |
Invoice ID | The unique ID of the invoice. |
The available fields in the ‘Payment Sources' data source and their corresponding descriptions are listed below.
Field | Description |
Card Brand | Represent the brand of the card. Possible Values are visa, master_card, american_express, etc. |
Amazon Email | The email address associated with the Amazon payment account. |
Card Funding Type | Indicates 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 ID | The gateway account to which the payment source is associated. |
Customer Handle | Displays the customer’s unique identifier associated with the payment source. |
Bank Name On Acount | Account holder’s name as per the bank account. |
Card First Name | Account holder’s first name as per the bank account. |
Bank Last Four Digits | The last four digits of the bank account number. |
Card Expiry Year | The expiry year of the card. |
IP Address | The IP address of the customer. |
Paypal Agreement ID | Billing agreement ID of PayPal. |
Card Billing Address2 | Address line 2, as available in the card billing address. |
Card Iin | The Issuer Identification Number, i.e., the first six digits of the card number. |
Card Billing Address 1 | Address line 1, as available in the card billing address. |
Deleted | Indicates that this resource has been deleted. |
Bank Account Type | Indicates 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 Digits | The last four digits of the card number |
Card Billing City | City, as available in the card billing address. |
Card Billing Country | The billing address country of the customer. It is one of ISO 3166 alpha-2 country code. |
Bank Echeck Type | Specifies 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) |
Status | Represents 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 Month | Card expiry month of the card |
Card Billing Zip | Postal or Zip code, as available in the card billing address. |
Business Entity ID | The 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 Code | The 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 State | The state/province name. |
Card Masked Number | A masked credit card number that is safe to show. |
Type | Displays the type of payment source. The Possible values are card, paypal_express_checkout, amazon_payments, and direct_debit. |
Issuing Country | Two-letter(alpha2) ISO country code. |
Bank Mandate ID | Bank account details of the direct debit, ACH, or NetBanking agreement/mandate created with this payment source. |
Bank Account Holder Type | Indicates the account holder type. Possible values are individual and company. |
Paypal Email | The email address associated with PayPal Express Checkout. |
Bank Name | Name of the account holder’s bank. |
Card Last Name | Cardholder's last name. |
Handle | Unique Identifier of the Payment Source. |
Reference ID | The 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 ID | Billing agreement ID of Amazon Payment. |
Gateway | Gateway 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). |
The available fields in the ‘Subscription Discounts' data source and their corresponding descriptions are listed below.
Field | Description |
|---|---|
Subscription Discounts ID | An immutable, unique id for the discount. It is always auto-generated. |
Invoice Name | The 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. |
Percentage | The percentage of the original amount that should be deducted from it. |
Amount | The value of the discount. The format of this value depends on the kind of currency. |
Currency Code | The currency code (ISO 4217 format) of the discount. This is only applicable when discount.type is fixed_amount. |
Duration Type | Specifies the time duration for which this discount is attached to the subscription. |
Type | The type of discount. Possible values are: fixed_amount : The specified amount will be given as discount. |
Apply Till | Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period duration type discount. |
Applied Count | Specifies the number of times the discount has been applied. |
Period | The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period. |
Period Unit | The unit of time for period. Applicable only when duration_type is limited_period. |
Apply On | The amount on the invoice to which the discount is applied. |
Item Price ID | The 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 ID | The 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 Date | Timestamp indicating when this discount was created. |
Included In MRR | The 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. |
The available fields in the ‘Subscription Addons' data source and their corresponding descriptions are listed below.
Field | Description |
|---|---|
Customer ID | The 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 ID | The 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 ID | Acts as a unique identifier of the Subscription Addon. |
Quantity | The quantity of the item purchased. |
Currency Code | The currency code (ISO 4217 format) of the subscription. |
Unit Price | The 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. |
Amount | The 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 End | The date/time when the trial period of the item ends. |
Remaining Billing Cycles | Denotes the number of subscription billing cycles for which the addon is included. |
Business Entity ID | Represents a unique business unit or brand under the organization. |
Was this article helpful?