---
title: "Subscriptions (Chargebee)"
description: "Subscriptions"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/chargebee/Chargebee.Subscriptions.Subscriptions
original: https://documentation.invantive.eu/en/datamodels/chargebee/Chargebee.Subscriptions.Subscriptions
updated: 2024-06-10T18:44:26Z
license: https://documentation.invantive.eu/en/
---

# Subscriptions: Chargebee Subscriptions

`insert` `update` `delete` `REST`

- Catalog: `Chargebee`
- Schema: `Subscriptions`
- Primary Keys: `id`
- Label: Subscriptions

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

## API Source

- Endpoint: `/subscriptions`

## 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 | Marks | Documentation |
|---|---|---|:---:|---|---|
| `activated_at` | `datetime` | Activated at | [ ] |  |  |
| `active_id` | `varchar2(50)` | itgen_cbe_active_id | [ ] |  | Represents the id of the active version of the customer resource. |
| `affiliate_token` | `varchar2` | Affiliate Token | [ ] |  |  |
| `auto_close_invoices` | `char` | itgen_cbe_auto_close_invoices | [ ] |  |  |
| `auto_collection` | `varchar2` | Auto Collection | [ ] |  |  |
| `base_currency_code` | `varchar2` | Base Currency Code | [ ] |  |  |
| `billing_period` | `int16` | Billing Period | [ ] |  |  |
| `billing_period_unit` | `varchar2` | Billing Period Unit | [ ] |  |  |
| `business_entity_id` | `varchar2` | itgen_cbe_business_entity_id | [ ] |  |  |
| `cancel_reason` | `varchar2` | Cancel Reason | [ ] |  |  |
| `cancel_reason_code` | `varchar2` | Cancel Reason Code | [ ] |  |  |
| `cancel_schedule_created_at` | `datetime` | itgen_cbe_cancel_schedule_created_at | [ ] |  |  |
| `cancelled_at` | `datetime` | Cancelled at | [ ] |  |  |
| `changes_scheduled_at` | `datetime` | itgen_cbe_changes_scheduled_at | [ ] |  |  |
| `channel` | `varchar2(30)` | itgen_cbe_channel | [ ] |  | 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` | `varchar2` | Contract Term Action at Term End | [ ] |  |  |
| `contract_term_billing_cycle` | `int32` | Contract Term Billing Cycle | [ ] |  |  |
| `contract_term_billing_cycle_on_renewal` | `int32` | Contract Term Billing Cycle on Renewal | [ ] |  |  |
| `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` | `varchar2` | Contract Term ID | [ ] |  |  |
| `contract_term_remaining_billing_cycles` | `int32` | Contract Term Remaining Billing Cycles | [ ] |  |  |
| `contract_term_status` | `varchar2` | Contract Term Status | [ ] |  |  |
| `contract_term_subscription_id` | `varchar2` | Contract Term Subscription ID | [ ] |  |  |
| `contract_term_total_contract_value` | `decimal` | Contract Term Total Contract Value | [ ] |  |  |
| `contract_term_total_contract_value_before_tax` | `decimal` | itgen_cbe_contract_term_total_contract_value_before_tax | [ ] |  |  |
| `create_pending_invoices` | `char` | itgen_cbe_create_pending_invoices | [ ] |  |  |
| `created_at` | `datetime` | Created at | [ ] |  |  |
| `created_from_ip` | `varchar2` | Created From IP | [ ] |  |  |
| `currency_code` | `varchar2` | Currency Code | [ ] |  |  |
| `current_term_end` | `datetime` | Current Term End | [ ] |  |  |
| `current_term_start` | `datetime` | Current Term Start | [ ] |  |  |
| `customer_id` | `varchar2` | Customer ID | [ ] |  |  |
| `deleted` | `char` | Deleted | [ ] |  |  |
| `due_invoices_count` | `int32` | Due Invoices Count | [ ] |  |  |
| `due_since` | `datetime` | Due Since | [ ] |  |  |
| `exchange_rate` | `decimal` | Exchange Rate | [ ] |  |  |
| `free_period` | `int32` | Free Period | [ ] |  |  |
| `free_period_unit` | `varchar2` | Free Period Unit | [ ] |  |  |
| `gift_id` | `varchar2` | Gift ID | [ ] |  |  |
| `has_scheduled_advance_invoices` | `char` | itgen_cbe_has_scheduled_advance_invoices | [ ] |  |  |
| `has_scheduled_changes` | `char` | Has Scheduled Changes | [ ] |  |  |
| `id` | `varchar2` | ID | [x] |  |  |
| `invoice_notes` | `varchar2` | Invoice Notes | [ ] |  |  |
| `meta_data` | `varchar2` | Meta Data | [ ] |  |  |
| `mrr` | `int32` | MRR | [ ] |  |  |
| `net_term_days` | `int32` | Net Term Days | [ ] |  |  |
| `next_billing_at` | `datetime` | Next Billing at | [ ] |  |  |
| `offline_payment_method` | `varchar2` | Offline Payment Method | [ ] |  |  |
| `override_relationship` | `char` | Override Relationship | [ ] |  |  |
| `pause_date` | `datetime` | Pause Date | [ ] |  |  |
| `payment_source_id` | `varchar2` | Payment Source ID | [ ] |  |  |
| `plan_amount` | `decimal` | Plan Amount | [ ] |  |  |
| `plan_amount_in_decimal` | `varchar2` | Plan Amount in Decimal | [ ] |  |  |
| `plan_free_quantity` | `int32` | Plan Free Quantity | [ ] |  |  |
| `plan_free_quantity_in_decimal` | `varchar2` | Plan Free Quantity in Decimal | [ ] |  |  |
| `plan_id` | `varchar2` | Plan ID | [ ] |  |  |
| `plan_quantity` | `int32` | Plan Quantity | [ ] |  |  |
| `plan_quantity_in_decimal` | `varchar2` | Plan Quantity in Decimal | [ ] |  |  |
| `plan_unit_price` | `decimal` | Plan Unit Price | [ ] |  |  |
| `plan_unit_price_in_decimal` | `varchar2` | Plan Unit Price in Decimal | [ ] |  |  |
| `po_number` | `varchar2` | PO Number | [ ] |  |  |
| `referral_info_account_id` | `varchar2` | Referral Info Account ID | [ ] |  |  |
| `referral_info_campaign_id` | `varchar2` | Referral Info Campaign ID | [ ] |  |  |
| `referral_info_coupon_code` | `varchar2` | Referral Info Coupon Code | [ ] |  |  |
| `referral_info_destination_url` | `varchar2` | Referral Info Destination URL | [ ] |  |  |
| `referral_info_external_campaign_id` | `varchar2` | Referral Info External Campaign ID | [ ] |  |  |
| `referral_info_external_reference_id` | `varchar2` | Referral Info External Reference ID | [ ] |  |  |
| `referral_info_friend_offer_type` | `varchar2` | Referral Info Friend Offer Type | [ ] |  |  |
| `referral_info_notify_referral_system` | `varchar2` | Referral Info Notify Referral System | [ ] |  |  |
| `referral_info_post_purchase_widget_enabled` | `char` | Referral Info Post Purchase Widget Enabled | [ ] |  |  |
| `referral_info_referral_code` | `varchar2` | Referral Info Referral Code | [ ] |  |  |
| `referral_info_referral_system` | `varchar2` | Referral Info Referral System | [ ] |  |  |
| `referral_info_referrer_id` | `varchar2` | Referral Info Referrer ID | [ ] |  |  |
| `referral_info_referrer_reward_type` | `varchar2` | Referral Info Referrer Reward Type | [ ] |  |  |
| `referral_info_reward_status` | `varchar2` | 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` | `varchar2` | Shipping Address City | [ ] |  |  |
| `shipping_address_company` | `varchar2` | Shipping Address Company | [ ] |  |  |
| `shipping_address_country` | `varchar2` | Shipping Address Country | [ ] |  |  |
| `shipping_address_email` | `varchar2` | Shipping Address Email | [ ] |  |  |
| `shipping_address_first_name` | `varchar2` | Shipping Address First Name | [ ] |  |  |
| `shipping_address_last_name` | `varchar2` | Shipping Address Last Name | [ ] |  |  |
| `shipping_address_line1` | `varchar2` | Shipping Address Line 1 | [ ] |  |  |
| `shipping_address_line2` | `varchar2` | Shipping Address Line 2 | [ ] |  |  |
| `shipping_address_phone` | `varchar2` | Shipping Address Phone | [ ] |  |  |
| `shipping_address_state` | `varchar2` | Shipping Address State | [ ] |  |  |
| `shipping_address_state_code` | `varchar2` | itgen_cbe_shipping_address_state_code | [ ] |  |  |
| `shipping_address_validation_status` | `varchar2` | Shipping Address Validation Status | [ ] |  |  |
| `shipping_address_zip` | `varchar2` | Shipping Address ZIP Code | [ ] |  |  |
| `start_date` | `datetime` | Start Date | [ ] |  |  |
| `started_at` | `datetime` | Started at | [ ] |  |  |
| `status` | `varchar2` | Status | [ ] |  |  |
| `total_dues` | `int32` | Total Dues | [ ] |  |  |
| `trial_end` | `datetime` | Trial End | [ ] |  |  |
| `trial_end_action` | `varchar2(30)` | itgen_cbe_trial_end_action | [ ] |  | 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_start` | `datetime` | Trial Start | [ ] |  |  |
| `updated_at` | `datetime` | Updated at | [ ] |  |  |



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

- [Chargebee](/en/release-notes/drivers?driver=chargebee)

