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).
string, max chars=40
Uniquely identifies the order. It is the api identifier for the order.
optional, string, max chars=50
The order's serial number.
optional, string, max chars=50
The invoice number which acts as an identifier for invoice and is generated sequentially.
optional, string, max chars=50
The subscription for which the order is created.
optional, string, max chars=50
The customer for which the order is created.
optional, enumerated string, default=newThe status of this order.
Possible values are
newOrder has been created. Applicable only if you are using Chargebee's legacy order management system.processingOrder is being processed. Applicable only if you are using Chargebee's legacy order management system.completeOrder has been processed successfully. Applicable only if you are using Chargebee's legacy order management system.cancelledOrder has been cancelled. Applicable only if you are using Chargebee's legacy order management system.voidedOrder has been voided. Applicable only if you are using Chargebee's legacy order management system.queuedOrder is yet to be processed by any system, these are scheduled orders created by Chargebee.awaiting_shipmentThe order has been picked up by an integration system, and synced to a shipping management platform.on_holdThe order is paused from being processed.deliveredThe order has been delivered to the customer.shippedThe order has moved from order management system to a shipping system.partially_deliveredThe order has been partially delivered to the customer.returnedThe order has been returned after delivery.
Show all values[+]
optional, enumerated stringCancellation reason.
Possible values are
shipping_cut_off_passedThe invoice has been paid late and Chargebee cancel's the first order for the invoice.product_unsatisfactoryProduct unsatisfactory.third_party_cancellationThird party cancellation.product_not_requiredProduct not required.delivery_date_missedDelivery date missed.alternative_foundAlternative found.invoice_written_offThe invoice has been completely written off. Orders are generated by Chargebee in cancelled state.invoice_voidedThe invoice for which the order was createed has been voided.fraudulent_transactionFraudulent transaction.payment_declinedPayment declined.subscription_cancelledThe subsctiption for which the order was created has been cancelled.product_not_availableProduct not available.othersOther reason.order_resentOrder resent.
Show all values[+]
optional, enumerated stringThe payment status of the order.
Possible values are
not_paidNOT_PAID.paidPAID.
optional, enumerated stringOrder type.
Possible values are
manualThe order has been created by the the user using Chargebee's legacy order management system.system_generatedThe order has been created by Chargebee automatically based on the preferences set by the user.
enumerated string, default=tax_exclusiveThe price type of the order.
Possible values are
tax_exclusiveAll amounts in the document are exclusive of tax.tax_inclusiveAll amounts in the document are inclusive of tax.
optional, string, max chars=50
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.
optional, string, max chars=50
The fulfillment status of an order as reflected in the shipping/order management application. Typical statuses include Shipped,Awaiting Shipment,Not fulfilled etc;.
optional, timestamp(UTC) in seconds
The date on which the order will start getting processed.
optional, timestamp(UTC) in seconds
This is the date on which the order will be delivered to the customer.
optional, string, max chars=600
The custom note for the order.
optional, string, max chars=50
The tracking id of the order.
optional, string, max chars=255
The tracking url of the order.
optional, string, max chars=50
Unique id to identify a group of orders.
optional, string, max chars=50
The source (or the user) from where the order has been created.
optional, string, max chars=50
Shipment carrier.
optional, in cents, min=0
The total round off taken from the invoice level.
optional, in cents, min=0
The total tax for the order.
optional, in cents, min=0
Total amount paid for the order.
optional, in cents, min=0
Total amount adjusted for the order.
refundable_credits_issued
optional, in cents, min=0
The total amount issued as credits on behalf of this order.
optional, in cents, min=0
The total amount that can be issued as credits for this order.
optional, in cents
Rounding adjustment.
optional, timestamp(UTC) in seconds
The timestamp indicating the date & time the order's invoice got paid.
optional, timestamp(UTC) in seconds
The time after which an order becomes unservicable.
timestamp(UTC) in seconds
The time at which the order was created.
optional, timestamp(UTC) in seconds
The time at which the order status was last updated.
optional, timestamp(UTC) in seconds
The time at which the order was delivered.
optional, timestamp(UTC) in seconds
The time at which the order was shipped.
optional, long
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.
optional, timestamp(UTC) in seconds
The order's last modified time.
optional, timestamp(UTC) in seconds
The time at which the order was cancelled.
optional, enumerated stringResent status of the order.
Possible values are
fully_resentOrder is Fully resent.partially_resentOrder is Partially resent.
boolean, default=false
Show if the order is resent order or not.
optional, string, max chars=40
Refers to the original order id of the resent order.
optional, in cents, min=0
Total discount given for the order.
optional, in cents, min=0
The order's sub-total.
optional, in cents, min=0
Total amount charged for the order.
boolean
Indicates that this resource has been deleted.
optional, string, max chars=3
The currency code (ISO 4217 format) for the invoice.
optional, boolean, default=false
Boolean indicating whether this order is gifted or not.
optional, string, max chars=500
The gift message added by the gifter during purchase.
optional, string, max chars=50
The gift_id if the order is a gift order.
optional, string, max chars=100
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.
optional, list of order_line_item
The list of line items for this order.
Order line item attributes
string, max chars=40
The identifier for the order line item.
string, max chars=50
The invoice of the line item.
string, max chars=40
The invoice line item id associated with this order line item.
optional, in cents, min=0
The unit price.
optional, string, max chars=250
The line item description.
optional, in cents, min=0
The sub total, of the order line item.
optional, integer, min=0
The quantity that is going to get fulfilled for this order.
optional, in cents, min=0
The amount that is going to get fulfilled for this order(amount after tax and discount).
optional, in cents, min=0
The total tax applied on this line item.
optional, in cents, min=0
The total amount paid on the invoice, on behalf of this delivery.
optional, in cents, min=0
The total amount adjusted on the invoice, on behalf of this delivery.
refundable_credits_issued
optional, in cents, min=0
The total refundable credits issued on the invoice, on behalf of this delivery.
optional, in cents, min=0
The total amount issued as credits on behalf of this delivery.
boolean
Appliable only if configured to include non shippable charges in orders, specifies if the charge is applicable for shipping.
optional, string, max chars=250
The SKU for the delivery.
optional, enumerated string, default=queuedThe status of this order.
Possible values are
queuedNot processed for shipping yet.awaiting_shipmentMoved to shipping platform.on_holdThe delivery has been moved to "On hold" status.deliveredThe order line item has been delivered.shippedThe order line item has been shipped.partially_deliveredThe order has been partially delivered to the customer.returnedThe order has been returned after delivery.cancelledThe order has been returned after delivery.
enumerated stringSpecifies the modelled entity (
plan /
addon etc) this line item is based on.
Possible values are
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan id.planIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan id.addonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon id.adhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case.
item_level_discount_amount
optional, in cents, min=0
Item level discount amount.
optional, in cents, min=0
The discount given on the order line item.
optional, string, max chars=50
The identifier of the modelled entity this lineitem is based on. Will be null for 'adhoc' entity type.
optional, shipping_address
Shipping address for the order.
Shipping address attributes
optional, string, max chars=150
The first name of the contact.
optional, string, max chars=150
The last name of the contact.
optional, string, max chars=70
The email address.
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1.
optional, string, max chars=150
Address line 2.
optional, string, max chars=150
Address line 3.
optional, string, max chars=50
The name of the city.
optional, string, max chars=50The
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
).
optional, string, max chars=50
The state/province name.
optional, string, max chars=50The 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 return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI
(the code for United Kingdom – Northern Ireland) is available as an option.
.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
optional, enumerated string, default=not_validatedThe address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
optional, billing_address
Billing address for the order.
Billing address attributes
optional, string, max chars=150
The first name of the billing contact.
optional, string, max chars=150
The last name of the billing contact.
optional, string, max chars=70
The email address.
optional, string, max chars=250
The company name.
optional, string, max chars=50
The phone number.
optional, string, max chars=150
Address line 1.
optional, string, max chars=150
Address line 2.
optional, string, max chars=150
Address line 3.
optional, string, max chars=50
The name of the city.
optional, string, max chars=50The
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
).
optional, string, max chars=50
State or Province.
optional, string, max chars=50The 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 return an error.
Brexit
If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then XI
(the code for United Kingdom – Northern Ireland) is available as an option.
.
optional, string, max chars=20Zip or postal code. The number of characters is validated according to the rules
specified here.
optional, enumerated string, default=not_validatedThe address verification status.
Possible values are
not_validatedAddress is not yet validated.validAddress was validated successfully.partially_validThe address is valid for taxability but has not been validated for shipping.invalidAddress is invalid.
optional, list of line_item_tax
The list of taxes applied on the order line items.
optional, string, max chars=40
The unique reference id of the line item for which the tax is applicable.
string, max chars=100
The name of the tax applied.
double, default=0.0, min=0.0, max=100.0
The rate of tax used to calculate tax amount.
optional, boolean
Indicates if tax is applied only on a portion of the line item amount.
optional, boolean
Indicates the non-compliance tax that should not be reported to the jurisdiction.
in cents, min=0
Indicates the actual portion of the line item amount that is taxable.
in cents, min=0
The tax amount.
optional, enumerated stringThe type of tax jurisdiction.
Possible values are
countryThe tax jurisdiction is a country.federalThe tax jurisdiction is a federal.stateThe tax jurisdiction is a state.countyThe tax jurisdiction is a county.cityThe tax jurisdiction is a city.specialSpecial tax jurisdiction.unincorporatedCombined tax of state and county.otherJurisdictions other than the ones listed above.
optional, string, max chars=250
The name of the tax jurisdiction.
optional, string, max chars=250
The tax jurisdiction code.
tax_amount_in_local_currency
optional, in cents, min=0
Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
optional, string, max chars=3
The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
optional, list of line_item_discount
The list of discounts applied for the order.
Line item discount attributes
string, max chars=50
The unique reference id of the line item for which the discount is applicable.
enumerated stringType of this discount line item.
Possible values are
item_level_couponRepresents the 'Item' level coupons applied to this invoice. Further the 'coupon_id' attribute specifies the coupon id this discount is based on.document_level_couponRepresents the 'Document' level coupons applied to this document. Further the 'coupon_id' attribute specifies the coupon id this discount is based on.promotional_creditsRepresents the Promotional Credits item in invoice. The 'coupon_id' attribute will be null in this case.prorated_creditsRepresents the credit adjustment items in invoice. The 'coupon_id' attribute will be null in this case.custom_discountRepresents the discount applied on an resent order against the orginal order.
in cents, min=0
Discount amount.
optional, list of order_line_item_linked_credit
The credit notes linked to the order.
Linked credit note attributes
optional, in cents, min=0
The amount issued for this order.
enumerated stringThe credit note type.
Possible values are
adjustmentAdjustment Credit Note.refundableRefundable Credit Note.
string, max chars=50
Credit-note id.
enumerated stringThe credit note status.
Possible values are
adjustedWhen the Credit Note has been adjusted against an invoice.refundedWhen the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded).refund_dueWhen the credits are yet to be used, or have been partially used.voidedWhen the Credit Note has been cancelled.
optional, in cents, min=0
Total amount adjusted on the order for the linked credit note. Applicable if the linked credit note is of the type 'adjustement'.
optional, in cents, min=0
Total refundable credits issued on the order for the linked credit note. Applicable if the linked credit note is of the type 'refundable'.
optional, list of resent_order
The list of resent orders applied on the order.
string, max chars=40
The order which is linked.
optional, string, max chars=100
The order resent reason.
optional, in cents, min=0
Value of the resent order.