1. Invoicing
  2. Orders

Orders

orders
copy
Click to Copy

Orders are automatically generated for an invoice when it gets paid, based on the shipping preference chosen for the invoice's product and the shipping date configuration. They can be updated either via api or merchant web console (a.k.a admin console).

Related Tables

Tables referencing orders.id
resent_orders order_linked_credit_notes order_line_item_discounts order_line_items order_line_item_taxes

Columns

No match found
id string, not null
Primary Key
Uniquely identifies the order. It is the api identifier for the order
subscription_id string, null
Foreign Key subscriptions.id
The subscription associated with the order.
invoice_id string, null
Foreign Key invoices.id
The invoice number which acts as an identifier for invoice and is generated sequentially.
customer_id string, null
Foreign Key customers.id
The customer for which the order is created
business_entity_id string, null
Foreign Key business_entities.id
The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer.
amount_adjusted long, null
Total amount adjusted for the order.
amount_paid long, null
Total amount paid for the order.
batch_id string, null
Unique id to identify a group of orders.
billing_address_city string, null
The name of the city.
billing_address_company string, null
The company name.
billing_address_country string, null
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
billing_address_email string, null
The email address.
billing_address_first_name string, null
The first name of the billing contact.
billing_address_last_name string, null
The last name of the billing contact.
billing_address_line1 string, null
Address line 1
billing_address_line2 string, null
Address line 2
billing_address_line3 string, null
Address line 3
billing_address_phone string, null
The phone number.
billing_address_state string, null
State or Province
billing_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
billing_address_validation_status string, null, default=not_validated
The address verification status. Possible values are:
  • invalid: Address is invalid.
  • not_validated: Address is not yet validated.
  • partially_valid: The address is valid for taxability but has not been validated for shipping.
  • valid: Address was validated successfully.
billing_address_zip string, null
Zip or postal code. The number of characters is validated according to the rules specified here.
cancellation_reason string, null
Cancellation reason. Possible values are:
  • alternative_found: Alternative found.
  • delivery_date_missed: Delivery date missed.
  • fraudulent_transaction: Fraudulent transaction.
  • invoice_voided: The invoice for which the order was created has been voided.
  • invoice_written_off: The invoice has been completely written off. Orders are generated by Chargebee in cancelled state.
  • order_resent: Order resent.
  • others: Other reason.
  • payment_declined: Payment declined.
  • product_not_available: Product not available.
  • product_not_required: Product not required.
  • product_unsatisfactory: Product unsatisfactory.
  • shipping_cut_off_passed: The invoice has been paid late, and Chargebee cancels the first order for the invoice.
  • subscription_cancelled: The subscription for which the order was created has been cancelled.
  • third_party_cancellation: Third party cancellation.
cancelled_at timestamp, null
The time at which the order was cancelled.
created_at timestamp, not null
The time at which the order was created
created_by string, null
The source (or the user) from where the order has been created.
currency_code string, null
The currency code (ISO 4217 format) for the invoice
delivered_at timestamp, null
The time at which the order was delivered
discount long, null
Total discount given for the order.
document_number string, null
The order's serial number
fulfillment_status string, null
The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;
gift_id string, null
The gift_id if the order is a gift order
gift_note string, null
The gift message added by the gifter during purchase
invoice_round_off_amount long, null
The total round off taken from the invoice level
is_gifted boolean, null, default=false
Boolean indicating whether this order is gifted or not.
is_resent boolean, not null, default=false
Show if the order is resent order or not.
note string, null
The custom note for the order.
order_date timestamp, null
The date on which the order will start getting processed.
order_type string, null
Order type. Possible values are:
  • manual: The order has been created by the user using Chargebee's legacy order management system.
  • system_generated: The order has been created by Chargebee automatically based on the preferences set by the user.
original_order_id string, null
Refers to the original order id of the resent order.
payment_status string, null
The payment status of the order. Possible values are:
  • not_paid: NOT_PAID.
  • paid: PAID.
price_type string, not null, default=tax_exclusive
The price type of the order. Possible values are:
  • tax_exclusive: All amounts in the document are exclusive of tax.
  • tax_inclusive: All amounts in the document are inclusive of tax.
reference_id string, null
Reference id can be used to map the orders in the shipping/order management application to the orders in ChargeBee. The reference_id generally is same as the order id in the third party application.
refundable_credits long, null
The total amount that can be issued as credits for this order.
refundable_credits_issued long, null
The total amount issued as credits on behalf of this order.
resend_reason string, null
Reason code for resending the order. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Orders > Order Resend. Must be passed if set as mandatory in the app. The codes are case-sensitive
resent_status string, null
Resent status of the order. Possible values are:
  • fully_resent: Order is fully resent.
  • partially_resent: Order is partially resent.
resource_version long, null
Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
rounding_adjustement long, null
Rounding adjustment
shipment_carrier string, null
Shipment carrier
shipped_at timestamp, null
The time at which the order was shipped.
shipping_address_city string, null
The name of the city.
shipping_address_company string, null
The company name.
shipping_address_country string, null
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will show an error. For reporting and analysis, always use valid country codes.

shipping_address_email string, null
The email address.
shipping_address_first_name string, null
The first name of the contact associated with the shipping address.
shipping_address_index null
The index number of the subscription to which the item price is added. Provide a unique number between 0 and 4 (inclusive) for each subscription created.
shipping_address_last_name string, null
The last name of the contact associated with the shipping address.
shipping_address_line1 string, null
The first line of the shipping address.
shipping_address_line2 string, null
The second line of the shipping address.
shipping_address_line3 string, null
The third line of the shipping address.
shipping_address_phone string, null
The phone number associated with the shipping address.
shipping_address_state string, null
The state or province name in the shipping address.
shipping_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Supported for USA, Canada, and India. For example, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
shipping_address_validation_status string, null, default=not_validated
shipping_address_zip string, null
The zip or postal code of the shipping address. The number of characters is validated according to the rules specified here.
shipping_cut_off_date timestamp, null
The time after which the order becomes unserviceable.
shipping_date timestamp, null
The date on which the order is scheduled for delivery.
status string, null, default=new
The status of the order. Possible values are:
  • awaiting_shipment: The order has been picked up by an integration system and synced to a shipping management platform.
  • cancelled: The order has been cancelled.
  • complete: The order has been processed successfully.
  • delivered: The order has been delivered to the customer.
  • new: The order has been created.
  • on_hold: The order is paused from being processed.
  • partially_delivered: The order has been partially delivered to the customer.
  • processing: The order is being processed.
  • queued: The order is scheduled for processing.
  • returned: The order has been returned after delivery.
  • shipped: The order has been shipped.
  • voided: The order has been voided.
status_update_at timestamp, null
The time when the order status was last updated.
sub_total long, null
The subtotal of the order.
tax long, null
The total tax applied to the order.
total long, null
The total amount charged for the order.
tracking_id string, null
The tracking ID of the order.
tracking_url string, null
The tracking url of the order.
updated_at timestamp, null
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.