1. Billing
  2. Contract terms

Contract terms

contract_terms
copy
Click to Copy
Subscriptions can run indefinitely or for a fixed number of billing cycles. Subscriptions can also have 'contract terms', which define a lock-in period for a certain number of billing cycles. This prevents the subscription from being canceled by the customer within the contract term.

Columns

No match found
id string, not null
Primary Key
The ID that uniquely identifies the contract term in the site.
subscription_id string, not null
Foreign Key subscriptions.id
The ID of the subscription that this contract term is for.
action_at_term_end string, not null, default=renew
The action to take when the contract term completes. Possible values are:
  • `cancel`: The contract term completes and the subscription is canceled.
  • `evergreen`: The contract term completes and the subscription renews indefinitely.
  • `renew`:
    • The contract term completes and a new contract term starts for the number of billing cycles specified in `contract_billing_cycle_on_renewal`.
    • The `action_at_term_end` for the new contract term is set to `renew`.
  • `renew_once`: Used when you want to renew the contract term just once.
    • The contract term completes and a new contract term starts for the number of billing cycles specified in `contract_billing_cycle_on_renewal`.
    • The `action_at_term_end` for the new contract term is set to `cancel`.
billing_cycle not null
The number of billing cycles of the subscription for which the contract term runs.
cancellation_cutoff_period null
The number of days before `contract_end`, during which the customer is barred from canceling the contract term. The customer can cancel the contract term via the Self-Serve Portal only before this period. This allows sufficient time for processing the contract term closure.
contract_end timestamp, not null
The date when the contract term ends.
contract_start timestamp, not null
The date when the contract term begins.
created_at timestamp, not null
The date when the contract term was created.
remaining_billing_cycles null
The number of subscription billing cycles remaining after the current one for the contract term.
status string, not null
The current status of the contract. Possible values are:
  • `active`: An actively running contract term.
  • `cancelled`: The contract term ended because:
  • `completed`: The contract term has run its full duration.
  • `terminated`: The contract term was terminated ahead of completion.
total_contract_value long, not null, default=0
The sum of the totals of all 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, this value includes the value passed for `total_amount_raised`.
total_contract_value_before_tax long, not null, default=0
This refers to the total expected revenue from a specific contract term, calculated as the sum of all invoices raised during the term, regardless of payment status. It is based on past performance and the specified currency in the contract. If the subscription was imported, the value for `total_amount_raised_before_tax` is included in the calculation of the total contract value before tax. This value excludes any applicable taxes.
record_extracted_at timestamp
The column represents the timestamp when the updated data became available in Chargebee's data lakehouse.
record_exported_at timestamp
The column represents the timestamp when the data was exported to the configured destination.
change_type string
The column indicates the type of change [create, update, delete, read] and can be used to load data into the warehouse accordingly.