Skip to main content

Interface: Order

Properties

address_id

address_id: number

The id of the associated Address within Recharge.


billing_address

billing_address: AssociatedAddress

The billing address at the time the order was created. See Addresses for detailed address information.


charge

charge: object

An object containing parameters of the Charge.

external_transaction_id

external_transaction_id: ExternalTransactionId

An object containing external transaction ids associated with this charge, as they appear in external platforms.

id

id: number

The id of the charge associated with this order.


client_details

client_details: object

Details of the access method used by the purchase.

browser_ip

browser_ip: string

The IP address of the buyer as detected in Checkout.

user_agent

user_agent: string

The user agent detected during Checkout.


created_at

created_at: string

The date when the order was created.


currency

currency: string

The currency of the payment used to create the order.


customer

customer: object

Object that contains information about the Customer.

email

email: string

The user email.

external_customer_id

external_customer_id: ExternalId

An object containing customer information associated with this charge.

hash

hash: string

The hash of the Customer associated with the Charge.

id

id: number

The ID of the associated customer record.


discounts

discounts: Discount[]

An array of Discounts associated with the Order.


error

error: string

Error information about the order if status is 'error'


external_cart_token

external_cart_token: string

The cart token as it appears in an external system.


external_order_id?

optional external_order_id: ExternalId

An object containing external order ids.


external_order_number

external_order_number: ExternalId

An object containing the external order numbers.


id

id: number

The unique numeric identifier for the order.


include?

optional include: object

Additional information as requested

customer?

optional customer: Customer

metafields?

optional metafields: Metafield[]


is_prepaid?

optional is_prepaid: boolean

A boolean representing if this Order is generated from a prepaid purchase.


line_items

line_items: LineItem[]

A list of line_item objects.


note

note: string

Notes associated with the Order.


order_attributes

order_attributes: Property[]

An array of name value pairs of note attributes on the Order.


processed_at

processed_at: string

The date time that the associated charge was processed at.


scheduled_at

scheduled_at: string

The date time of when the associated charge is/was scheduled to process.


shipping_address

shipping_address: AssociatedAddress

The shipping address where the order will be shipped. See Addresses for detailed Address information.


shipping_lines

shipping_lines: ShippingLine[]

An array of shipping lines associated with the order.


status

status: OrderStatus

The status of creating the Order.


subtotal_price

subtotal_price: string

The subtotal price (sum of all line items * their quantity) of the order less discounts.


tags

tags: string

A comma separated list of tags on the Order.


tax_lines

tax_lines: TaxLine[]

An array of tax lines that apply to the Order.


taxable

taxable: boolean

A boolean indicator of the taxability of the Order.


total_discounts

total_discounts: string

The total discounted dollar value of the Order.


total_line_items_price

total_line_items_price: string

The total price of all line items of the Order.


total_price

total_price: string

The total amount due of the Order.


total_refunds

total_refunds: string

The total dollar amount of refunds associated with the Order.


total_tax

total_tax: string

The total tax due associated with the Order.


total_weight_grams

total_weight_grams: number

The total weight of the order in grams.


type

type: OrderType

An indicator of the order’s type.


updated_at

updated_at: string

The date time at which the order was most recently updated.