WooCommerce: Retrieve Paid Orders Only

The wc_get_orders function is the recommended method for fetching orders in WooCommerce due to its flexibility, safety, and adherence to best practices. It offers several advantages over using custom WP_Query or database queries. It’s also HPOS compatible.

You can specify various arguments to filter orders based on properties like status (pending, completed, on-hold, etc.), customer (ID, email), date range, order IDs, payment method, total, custom fields and more.

Today, I’d like to talk about paid orders – at the moment there is no way to filter out free orders with a wc_get_orders parameter, so we need to find a workaround.

My solution uses the “payment_method” parameter, which accepts a payment method ID (cheque, bacs, afterpay, paypal, stripe, woocommerce_payments, ppcp-gateway, klarna_payments, etc. based on the payment gateway plugins you use). Clearly, an order that comes with a specific payment method is a paid order.

Unfortunately you can only select one payment method (as opposed to an array), so we also need to do some array merging. Enjoy!

You can find the official wc_get_orders documentation here.

PHP Snippet: Get List of Paid WooCommerce Orders

The provided PHP function, bbloomer_get_paid_orders, is designed to retrieve a list of paid orders in WooCommerce based on specific criteria.

It sets up four separate wc_get_orders argument arrays (args1 to args4) with the same list of parameters, except for payment_method, which specifies the payment gateway used for each query, including “ppcp-gateway” (PayPal Checkout Pro), “stripe”, “cheque”, and “bacs” (Bank Transfer). You can remove or add arrays in case you need to target different payment methods of course.

bbloomer_get_paid_orders is a function intended for custom development purposes within a theme or plugin. Here are some potential use cases:

  • Displaying a list of recently paid orders: You could integrate the function into a custom page or widget to showcase recent successful transactions using specific payment methods.
  • Triggering specific actions based on payment method: By iterating through the returned list of orders, you could perform actions based on the used payment method, such as sending customized notifications or integrating with external services.

Either way, simply call bbloomer_get_paid_orders() to get a list of order objects.

/**
 * @snippet       Get WooCommerce Non-Free Orders
 * @tutorial      Get CustomizeWoo.com FREE
 * @author        Rodolfo Melogli
 * @compatible    WooCommerce 8
 * @community     Join https://businessbloomer.com/club/
 */

function bbloomer_get_paid_orders() {

    // COMPLETED/PROCESSING ORDERS PAID VIA PAYPAL
    $args1 = array(
        'type' => 'shop_order',
        'limit' => -1,
        'status' => [ 'wc-completed', 'wc-processing' ],
        'payment_method' => 'ppcp-gateway',
    );

    // COMPLETED/PROCESSING ORDERS PAID VIA STRIPE
    $args2 = array(
        'type' => 'shop_order',
        'limit' => -1,
        'status' => [ 'wc-completed', 'wc-processing' ],
        'payment_method' => 'stripe',
    );

    // COMPLETED/PROCESSING ORDERS PAID VIA CHEQUE
    $args3 = array(
        'type' => 'shop_order',
        'limit' => -1,
        'status' => [ 'wc-completed', 'wc-processing' ],
        'payment_method' => 'cheque',
    );

    // COMPLETED/PROCESSING ORDERS PAID VIA BANK WIRE
    $args4 = array(
        'type' => 'shop_order',
        'limit' => -1,
        'status' => [ 'wc-completed', 'wc-processing' ],
        'payment_method' => 'bacs',
    );

    // ADD MORE ARRAYS OF ARGS FOR ADDITIONAL PAYMENT METHODS
    /* $args5 = array(); */
    /* $args6 = array(); */

    // MERGE ARRAYS AND RETURN LIST OF ORDERS
    return array_merge( wc_get_orders( $args1 ), wc_get_orders( $args2 ), wc_get_orders( $args3 ), wc_get_orders( $args4 ) );    

}

Where to add custom code?

You should place custom PHP in functions.php and custom CSS in style.css of your child theme: where to place WooCommerce customization?

This code still works, unless you report otherwise. To exclude conflicts, temporarily switch to the Storefront theme, disable all plugins except WooCommerce, and test the snippet again: WooCommerce troubleshooting 101

Related content

  • WooCommerce: How to Add a Custom Checkout Field
    Let’s imagine you want to add a custom checkout field (and not an additional billing or shipping field) on the WooCommerce Checkout page. For example, it might be a customer licence number – this has got nothing to do with billing and nothing to do with shipping. Ideally, this custom field could show above the […]
  • WooCommerce: Get Order Info (total, items, etc) From $order Object
    As a WooCommerce development freelancer, every day I repeat many coding operations that make me waste time. One of them is: “How to get ____ if I have the $order variable/object?“. For example, “How can I get the order total“? Or “How can I get the order items“? Or maybe the order dates, customer ID, […]
  • WooCommerce: Allow Users to Edit Processing Orders
    How can WooCommerce customers edit an order they just placed and paid for? I swear I looked on search engine results and other places before coming to the conclusion I needed to code this myself. For example, a user might want to change the delivery date (if you provide this on the checkout page). Or […]
  • WooCommerce: Create a Custom Order Status
    All WooCommerce orders go to either “processing”, “completed”, “on-hold” and other default order statuses based on the payment method and product type. Sometimes these statuses are not enough. For example, you might need to mark certain orders in a different way for tracking, filtering, exporting purposes. Or you might want to disable default emails by […]
  • WooCommerce: Add Column to Orders Table @ WP Dashboard
    The WooCommerce Orders Table, which can be found under WP Dashboard > WooCommerce > Orders, provides us with 7 default columns: Order – Date – Status – Billing – Ship to – Total – Actions. This is used by shop managers to have an overview of all orders, before eventually clicking on a specific one. […]

Rodolfo Melogli

Business Bloomer Founder

Author, WooCommerce expert and WordCamp speaker, Rodolfo has worked as an independent WooCommerce freelancer since 2011. His goal is to help entrepreneurs and developers overcome their WooCommerce nightmares. Rodolfo loves travelling, chasing tennis & soccer balls and, of course, wood fired oven pizza. Follow @rmelogli

Questions? Feedback? Customization? Leave your comment now!
_____

If you are writing code, please wrap it like so: [php]code_here[/php]. Failure to complying with this, as well as going off topic or not using the English language will result in comment disapproval. You should expect a reply in about 2 weeks - this is a popular blog but I need to get paid work done first. Please consider joining the Business Bloomer Club to get quick WooCommerce support. Thank you!

Your email address will not be published. Required fields are marked *