Subscriptions
The available fields in Subscriptions and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Canceled On | Time at which the subscription was canceled or is set to be canceled. |
| 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: If consolidated invoicing is enabled, or if the subscription is for a customer who is in a hierarchy and the parent of this customer owns and pays for the invoices, this field is not applicable. |
| 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: If consolidated invoicing is enabled, or if the subscription is for a customer who is in a hierarchy and the parent of this customer owns and pays for the invoices, this field is not applicable. |
| 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: If consolidated invoicing is enabled, or if the subscription is for a customer who is in a hierarchy and the parent of this customer owns and pays for the invoices, this field is not applicable. |
| 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. |