Chargebee activities and attributes

This page lists all default Chargebee activities that are added to your Ortto account after integrating Ortto with Chargebee when adding Chargebee as a data source.

NOTE: If your Chargebee data source was connected before 18 April, 2024 and you receive activity data in multiple currencies, you will see activity attributes containing the word "(raw)" added to Chargebee activities (e.g. Total (raw)). These "raw" attribute values represent the currency in which the activity was performed. Activity attributes without "raw" (e.g. Total) show the amount in your Ortto account's default currency.

For Chargebee data sources connected after 18 April, 2024, attributes containing "raw" will not be added, you will simply see the value in the currency in which the activity was performed.

Learn more about data sources and multi-currency data.

Invoice

The Invoice activity is generated by Chargebee when an invoice is created. This allows you to view the invoice details in Ortto, including invoice and customer details, and payment and invoice statuses.

Attribute	Field type	Description
Invoice ID	Text	The invoice number. Acts as a identifier for invoice and typically is generated sequentially.
Customer ID	Text	The identifier of the Chargebee contact this invoice belongs to.
PO number	Text	The purchase order (PO) number for this invoice.
VAT number	Text	The VAT/tax registration number of the Chargebee contact.
Amount paid	Currency	The payments collected successfully for the invoice.
Amount due	Currency	The unpaid amount that is due on the invoice.
Subtotal	Currency	The sum of all the line item amounts minus the sum of all line item discounts.
Total	Currency	The invoiced amount in cents.
Net term in day	Number	The number of days within which the invoice has to be paid.
Paid at	Time and date	The timestamp indicating the date and time this invoice was paid.
Status	Text	The current status of this invoice.

New trial, Subscription cancelled, Subscription change, Trial cancelled, and Trial expired

These activities and their attributes are generated by Chargebee each time a customer signs up for a product or service. Any associated addons or coupons are also added to the subscription. More than one subscription activity can be linked to a contact.

Attribute	Field type	Description
Subscription ID	Text	A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
Subscription currency code	Text	The currency code (ISO 4217 format) of the subscription.
Subscription customer ID	Text	The identifier of the Chargebee contact with whom this subscription is associated.
Plan ID	Text	The identifier of the plan for this subscription.
Plan quantity	Number	Represents the plan quantity for this subscription.
Plan unit price	Currency	The amount that will override the plan’s default price.
Plan amount	Currency	The total amount for the plan, denoted in cents.
Plan free quantity	Number	The units of the item that will be free with this plan.
Trial start	Time and date	The start of the trial period for the subscription. Presence of this value for future subscription implies the subscription will go into `in_trial` state when it starts.
Trial end	Time and date	The end of the trial period for the subscription.
Trial end action	Text	Applicable only when `End-of-trial Action` has been enabled. Whenever the subscription has a trial period, this attribute is returned and specifies the operation to be carried out for the subscription once the trial ends.
Is trial	Boolean	A status value for the subscription; the subscription is in trial.
Created At	Time and date	The time at which the subscription was created.
Started At	Time and date	The time at which the subscription was started. Is `null` for futures subscriptions as it is yet to be started.
Activated At	Time and date	The time at which the subscription status last changed to active. For example, this value is updated when an `in_trial` or `cancelled subscription` activates.
Cancelled At	Time and date	The time at which subscription was cancelled or is set to be cancelled.
Billing At	Time and date	The date/time at which the next billing for the subscription happens.
Updated At	Time and date	Timestamp indicating when the item was last updated.
Scheduled cancellation created at	Time and 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.
Scheduled cancellation at	Time and date	The time at which the scheduled subscription was cancelled or is set to be cancelled.
Free period	Number	The period of time by which the first term of the subscription is to be extended free-of-charge.
Free period unit	Text	Defines additional free period in association with the billing period.
Auto collection	Boolean	Whether payments needs to be collected automatically for this customer.
Billing period	Number	Defines billing frequency. For example, for a contact billed customer every 3 months, you will see `3` here.
Billing period unit	Text	Defines billing frequency in association with the billing period.
Current term start	Time and date	The start of the current billing period of the subscription.
Current term end	Time and date	The end of the current billing period of the subscription. Subscription is renewed immediately after this.
MRR	Currency	Monthly recurring revenue for the subscription. Updated asynchronously, this value catches up with changes to the subscription in less than a minute. The value depends on the type of currency. Note: This may not return accurate values since updated asynchronously.
Addon IDs	Text	The subscription item type (addon).
Addon total amount	Currency	The total amount for the addon. The format of the value depends upon the currency.
Status	Text	The current state of the subscription.
Coupon code	Text list	The coupon code used to redeem the coupon. Will be present only when associated code for a coupon is used.

Transaction

The Transaction activity is generated by Chargebee every time Chargebee makes a payment-related operation on an invoice such as a successful charge, failure, authorization or refund. The transaction activity provides you with details of the transaction activity that has happened in your account.

Attribute	Field type	Description
Transaction ID	Text	Uniquely identifies the transaction.
Customer ID	Text	Identifier of the customer for which this transaction is made.
Invoice IDs	Text list	The invoice number. Acts as a identifier for invoice and typically generated sequentially.
Subscription ID	Text	Identifier of the subscription for which this transaction is made.
Amount	Currency	The amount for this transaction, in cents.
Amount unused	Currency	This is the part of the amount which has not been invoiced yet.
Amount capturable	Currency	This is the part of the authorized amount that is yet to be captured.
Currency	Text	The currency code (ISO 4217 format) for the transaction.
Status	Text	The status of this transaction.