Chargebee API Data Model

activated_at

datetime

Activated at

☐

affiliate_token

string

Affiliate Token

☐

auto_collection

string

Auto Collection

☐

base_currency_code

string

Base Currency Code

☐

billing_period

int16

Billing Period

☐

billing_period_unit

string

Billing Period Unit

☐

cancel_reason

string

Cancel Reason

☐

cancel_reason_code

string

Cancel Reason Code

☐

cancelled_at

datetime

Cancelled at

☐

cf_main_subscription

string

☐

cf_nonrenewing

boolean

☐

cf_renewal_date

datetime

☐

contract_term_action_at_term_end

string

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

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

decimal

Contract Term Total Contract Value

☐

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

int32

Free Period

☐

free_period_unit

string

Free Period Unit

☐

gift_id

string

Gift ID

☐

has_scheduled_changes

boolean

Has Scheduled Changes

☐

id

string

ID

☑

invoice_notes

string

Invoice Notes

☐

meta_data

string

Meta Data

☐

mrr

int32

MRR

☐

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

decimal

Plan Amount

☐

plan_amount_in_decimal

string

Plan Amount in Decimal

☐

plan_free_quantity

int32

Plan Free Quantity

☐

plan_free_quantity_in_decimal

string

Plan Free Quantity in Decimal

☐

plan_id

string

Plan ID

☐

plan_quantity

int32

Plan Quantity

☐

plan_quantity_in_decimal

string

Plan Quantity in Decimal

☐

plan_unit_price

decimal

Plan Unit Price

☐

plan_unit_price_in_decimal

string

Plan Unit Price in Decimal

☐

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

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

datetime

Trial End

☐

trial_start

datetime

Trial Start

☐

updated_at

datetime

Updated at

☐