Skip to main content

Totals Object

Description

Financial totals for an order or checkout, including subtotals, taxes, shipping, and discounts.

Declaration

type Totals {
taxes: [Tax!]
subtotal: Float
subtotalBeforeTaxes: Float
tax: Float
grand: Float!
leftToPay: Float!
itemQuantity: Float
discount: Float
shipping: Float
creditNote: Float
balance: Float
}

Fields

NameTypeDescription
taxes[Tax!]Tax breakdown by tax definition.
subtotalFloatSubtotal after discounts and before taxes.
subtotalBeforeTaxesFloatSubtotal before taxes are applied.
taxFloatTotal tax amount across all tax definitions.
grandFloat!Grand total including all items, taxes, shipping, and discounts.
leftToPayFloat!Remaining amount left to pay (grand total minus payments received).
itemQuantityFloatTotal quantity of items in the order.
discountFloatTotal discount amount applied.
shippingFloatShipping cost.
creditNoteFloatCredit note amount applied.
balanceFloatBalance amount (positive or negative).