Navigation: Schema: Subscriptions > Tables

Subscriptions: Chargebee Subscriptions

Catalog: Chargebee

Schema: Subscriptions

Primary Keys: id

Label: Subscriptions

Can retrieve data and change data using insert, update and delete.

Table Columns

The columns of the table Subscriptions are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name	Data Type	Label	Required	Documentation
activated_at	datetime	Activated at	☐
active_id	string(50)		☐	Represents the id of the active version of the customer resource.
affiliate_token	string	Affiliate Token	☐
auto_close_invoices	boolean		☐
auto_collection	string	Auto Collection	☐
base_currency_code	string	Base Currency Code	☐
billing_period_unit	string	Billing Period Unit	☐
billing_period	int16	Billing Period	☐
business_entity_id	string		☐
cancel_reason_code	string	Cancel Reason Code	☐
cancel_reason	string	Cancel Reason	☐
cancel_schedule_created_at	datetime		☐
cancelled_at	datetime	Cancelled at	☐
changes_scheduled_at	datetime		☐
channel	string(30)		☐	The subscription channel this object originated from and is maintained in. Possible values are: web, app_store or play_store.
contract_term_action_at_term_end	string	Contract Term Action at Term End	☐
contract_term_billing_cycle_on_renewal	int32	Contract Term Billing Cycle on Renewal	☐
contract_term_billing_cycle	int32	Contract Term Billing Cycle	☐
contract_term_cancellation_cutoff_period	int32	Contract Term Cancellation Cut-off Period	☐
contract_term_contract_end	datetime	Contract Term Contract End	☐
contract_term_contract_start	datetime	Contract Term Contract Start	☐
contract_term_created_at	datetime	Contract Term Created at	☐
contract_term_id	string	Contract Term ID	☐
contract_term_remaining_billing_cycles	int32	Contract Term Remaining Billing Cycles	☐
contract_term_status	string	Contract Term Status	☐
contract_term_subscription_id	string	Contract Term Subscription ID	☐
contract_term_total_contract_value_before_tax	decimal		☐
contract_term_total_contract_value	decimal	Contract Term Total Contract Value	☐
create_pending_invoices	boolean		☐
created_at	datetime	Created at	☐
created_from_ip	string	Created From IP	☐
currency_code	string	Currency Code	☐
current_term_end	datetime	Current Term End	☐
current_term_start	datetime	Current Term Start	☐
customer_id	string	Customer ID	☐
deleted	boolean	Deleted	☐
due_invoices_count	int32	Due Invoices Count	☐
due_since	datetime	Due Since	☐
exchange_rate	decimal	Exchange Rate	☐
free_period_unit	string	Free Period Unit	☐
free_period	int32	Free Period	☐
gift_id	string	Gift ID	☐
has_scheduled_advance_invoices	boolean		☐
has_scheduled_changes	boolean	Has Scheduled Changes	☐
id	string	ID	☑
invoice_notes	string	Invoice Notes	☐
meta_data	string	Meta Data	☐
mrr	int32	MRR	☐
net_term_days	int32	Net Term Days	☐
next_billing_at	datetime	Next Billing at	☐
offline_payment_method	string	Offline Payment Method	☐
override_relationship	boolean	Override Relationship	☐
pause_date	datetime	Pause Date	☐
payment_source_id	string	Payment Source ID	☐
plan_amount_in_decimal	string	Plan Amount in Decimal	☐
plan_amount	decimal	Plan Amount	☐
plan_free_quantity_in_decimal	string	Plan Free Quantity in Decimal	☐
plan_free_quantity	int32	Plan Free Quantity	☐
plan_id	string	Plan ID	☐
plan_quantity_in_decimal	string	Plan Quantity in Decimal	☐
plan_quantity	int32	Plan Quantity	☐
plan_unit_price_in_decimal	string	Plan Unit Price in Decimal	☐
plan_unit_price	decimal	Plan Unit Price	☐
po_number	string	PO Number	☐
referral_info_account_id	string	Referral Info Account ID	☐
referral_info_campaign_id	string	Referral Info Campaign ID	☐
referral_info_coupon_code	string	Referral Info Coupon Code	☐
referral_info_destination_url	string	Referral Info Destination URL	☐
referral_info_external_campaign_id	string	Referral Info External Campaign ID	☐
referral_info_external_reference_id	string	Referral Info External Reference ID	☐
referral_info_friend_offer_type	string	Referral Info Friend Offer Type	☐
referral_info_notify_referral_system	string	Referral Info Notify Referral System	☐
referral_info_post_purchase_widget_enabled	boolean	Referral Info Post Purchase Widget Enabled	☐
referral_info_referral_code	string	Referral Info Referral Code	☐
referral_info_referral_system	string	Referral Info Referral System	☐
referral_info_referrer_id	string	Referral Info Referrer ID	☐
referral_info_referrer_reward_type	string	Referral Info Referrer Reward Type	☐
referral_info_reward_status	string	Referral Info Reward Status	☐
remaining_billing_cycles	int32	Remaining Billing Cycles	☐
resource_version	int64	Resource Version	☐
resume_date	datetime	Resume Date	☐
setup_fee	decimal	Setup Fee	☐
shipping_address_city	string	Shipping Address City	☐
shipping_address_company	string	Shipping Address Company	☐
shipping_address_country	string	Shipping Address Country	☐
shipping_address_email	string	Shipping Address Email	☐
shipping_address_first_name	string	Shipping Address First Name	☐
shipping_address_last_name	string	Shipping Address Last Name	☐
shipping_address_line1	string	Shipping Address Line 1	☐
shipping_address_line2	string	Shipping Address Line 2	☐
shipping_address_phone	string	Shipping Address Phone	☐
shipping_address_state_code	string		☐
shipping_address_state	string	Shipping Address State	☐
shipping_address_validation_status	string	Shipping Address Validation Status	☐
shipping_address_zip	string	Shipping Address ZIP Code	☐
start_date	datetime	Start Date	☐
started_at	datetime	Started at	☐
status	string	Status	☐
total_dues	int32	Total Dues	☐
trial_end_action	string(30)		☐	Applicable only when End-of-trial Action has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the item.type is plan and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the subscription-level. Possible values are: site_default, activate_subscription or cancel_subscription.
trial_end	datetime	Trial End	☐
trial_start	datetime	Trial Start	☐
updated_at	datetime	Updated at	☐

10-06-2024 18:44 Version 24.1.3-BETA+4689

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Chargebee API Data Model Chargebee Forums

Subscriptions: Chargebee Subscriptions

Table Columns

Important Safety and Usage Information