shopp_order_amt_balance()

get the current amount balance left uncharged on order

shopp_order_amt_balance ( $id, $by )

@param int $id the order id or txn id
@param string $by (optional default:id) lookup by 'id', or 'trans'
@return float|bool float amount balance on the order, bool false if order does not exist

Description

get the current amount balance left uncharged on order

Examples

get order amount balance by id

// get order balance for order 100
$balance = shopp_order_amt_balance( 100 );

get order amount balance by transaction id

// get order balance for order with transaction id QO4N2GHCDZBY32DFU
$balance = shopp_order_amt_balance( 'QO4N2GHCDZBY32DFU', 'trans' );

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar