Chargebee API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: Orders > Tables

Orders: Chargebee Orders

Contents Previous Home Next More

Catalog: Chargebee

Schema: Orders

Primary Keys: id

Label: Orders

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

Select Chargebee API URL: /orders

Insert Chargebee API URL: /orders

Update Chargebee API URL: /orders

Delete Chargebee API URL: /orders

Field Selection Method: NotRequired

Base Path: list[*].order

Table Columns

The columns of the table Orders 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 or update.

Name	Data Type	Label	Required
amount_adjusted	decimal	Amount Adjusted	☐
amount_paid	decimal	Amount Paid	☐
batch_id	string	Batch ID	☐
billing_address_city	string	Billing Address City	☐
billing_address_company	string	Billing Address Company	☐
billing_address_country	string	Billing Address Country	☐
billing_address_email	string	Billing Address Email	☐
billing_address_first_name	string	Billing Address First Name	☐
billing_address_last_name	string	Billing Address Last Name	☐
billing_address_line1	string	Billing Address Line 1	☐
billing_address_line2	string	Billing Address Line 2	☐
billing_address_line3	string	Billing Address Line 3	☐
billing_address_phone	string	Billing Address Phone	☐
billing_address_state	string	Billing Address State	☐
billing_address_validation_status	string	Billing Address Validation Status	☐
billing_address_zip	string		☐
cancellation_reason	string	Cancellation Reason	☐
cancelled_at	datetime	Cancelled at	☐
created_at	datetime	Created at	☐
created_by	datetime	Created by	☐
currency_code	string	Currency Code	☐
customer_id	string	Customer ID	☐
deleted	boolean	Deleted	☐
delivered_at	datetime	Delivered at	☐
discount	decimal	Discount	☐
document_number	string	Document Number	☐
fulfillment_status	string	Fulfillment Status	☐
gift_id	string	Gift ID	☐
gift_note	string	Gift Note	☐
id	string	ID	☑
invoice_id	string	Invoice ID	☐
invoice_round_off_amount	decimal	Invoice Round-off Amount	☐
is_gifted	boolean	Is Gifted	☐
note	string	Note	☐
order_date	datetime	Order Date	☐
order_type	string	Order Type	☐
paid_on	datetime	Paid on	☐
payment_status	string	Payment Status	☐
price_type	string	Price Type	☐
reference_id	string	Reference ID	☐
refundable_credits	decimal	Refundable Credits	☐
refundable_credits_issued	decimal	Refundable Credits Issued	☐
resource_version	int64	Resource Version	☐
rounding_adjustement	decimal	Rounding Adjustement	☐
shipment_carrier	string	Shipment Carrier	☐
shipped_at	datetime	Shipped at	☐
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	☐
shipping_cut_off_date	datetime	Shipping Cut-off Date	☐
shipping_date	datetime	Shipping Date	☐
status	string	Status	☐
status_update_at	datetime	Status Update at	☐
sub_total	decimal	Sub-total	☐
subscription_id	string	Subscription ID	☐
tax	decimal	Tax	☐
total	decimal	Total	☐
tracking_id	string	Tracking ID	☐
updated_at	datetime	Updated at	☐

12-12-2020 18:45 Version 20.1.301-BETA+3023

Please enable JavaScript to view this site.

Chargebee API Data Model

Table Columns