1. Invoicing
  2. Orders
  3. Order line items

Order line items

order_line_items
copy
Click to Copy
The list of line items for this order.
UPSERT KEY
order_id + record_id

Each row is uniquely identified by this combination. Use these columns together as the upsert key when applying incremental datasets to your warehouse.

Columns

No match found
id string, not null
The identifier for the order line item.
order_id string, not null
Foreign Key orders.id
The unique identifier of the order.
invoice_line_item_id string, not null
Foreign Key invoice_line_items.id
The invoice line item ID associated with this order line item.
invoice_id string, not null
Foreign Key invoices.id
The invoice of the line item.
amount long, null
The subtotal of the order line item.
amount_adjusted long, null
The total amount adjusted on the invoice, on behalf of this delivery.
amount_paid long, null
The total amount paid on the invoice, on behalf of this delivery.
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.
description string, null
The line item description.
discount_amount long, null
The discount given on the order line item.
entity_id string, null
The identifier of the modeled entity this line item is based on. Will be null for the 'adhoc' entity type.
entity_type string, not null
Specifies the modeled entity (plan/addon, etc.) this line item is based on. Possible values are:
  • addon: Indicates that this line item is based on the 'Addon' entity. The entity_id field specifies the addon ID.
  • addon_item_price: Indicates that this line item is based on an addon Item Price.
  • adhoc: Indicates that this line item is not modeled (created ad hoc). The entity_id field will be null in this case.
  • charge_item_price: Indicates that this line item is based on a charge Item Price.
  • plan: Indicates that this line item is based on the 'Plan' entity. The entity_id field specifies the plan ID.
  • plan_item_price: Indicates that this line item is based on a plan Item Price.
  • plan_setup: Indicates that this line item is based on a 'Plan Setup' charge. The entity_id field specifies the plan ID.
fulfillment_amount long, null
The amount that is going to get fulfilled for this order (amount after tax and discount).
fulfillment_quantity null
The quantity that is going to get fulfilled for this order.
is_shippable boolean, not null
Applicable only if configured to include non-shippable charges in orders, specifies if the charge is applicable for shipping.
item_level_discount_amount long, null
Item-level discount amount.
record_exported_at timestamp
The column represents the timestamp when the data was exported to the configured destination.
record_extracted_at timestamp
The column represents the timestamp when the updated data became available in Chargebee's data lakehouse.
record_id integer
The column represents the unique integer identifier for each child record within a parent subset.
refundable_credits long, null
The total amount issued as credits on behalf of this delivery.
refundable_credits_issued long, null
The total refundable credits issued on the invoice, on behalf of this delivery.
sku string, null
The SKU for the delivery.
status string, null, default=queued
The status of this order. Possible values are:
  • awaiting_shipment: Moved to the shipping platform.
  • cancelled: The order has been cancelled.
  • delivered: The order line item has been delivered.
  • on_hold: The delivery has been moved to "On hold" status.
  • partially_delivered: The order has been partially delivered to the customer.
  • queued: Not processed for shipping yet.
  • returned: The order has been returned after delivery.
  • shipped: The order line item has been shipped.
tax_amount long, null
The total tax applied on this line item.
unit_price long, null
The unit price.