public function OrderInterface::getBalance in Commerce Core 8.2

Gets the order balance.

Calculated by subtracting the total paid price from the total price. Can be negative in case the order was overpaid.

Return value

\Drupal\commerce_price\Price|null The order balance, or NULL.

1 method overrides OrderInterface::getBalance()

Order::getBalance in modules/order/src/Entity/Order.php

Gets the order balance.

File

modules/order/src/Entity/OrderInterface.php, line 301

Class

OrderInterface

Defines the interface for orders.

Namespace

Drupal\commerce_order\Entity

Code

public function getBalance();