View Categories

Settings

6 min read

All global options live under WooCommerce > Settings > Security Deposits. They are split into General Settings, which apply to every deposit, and Cart Deposit Settings, which configure the optional single per-order deposit.

The Security Deposits settings tab

General Settings #

SettingWhat it does
Disable Security DepositsSwitches off every deposit on the storefront in one click – no notices on product pages, no deposit fees in the cart, no automatic refunds. Product settings are kept, so you can turn deposits back on later. Useful for a promotion or while troubleshooting. Deposits already on existing orders can still be refunded from the order screen.
Enable Automatic RefundsWhen ticked, all deposits on an order are refunded automatically the moment the order’s status changes to Completed (or after the delay below). Each order can override this with its own Enable Automatic Refunds checkbox in the Security Deposits Summary box. When unticked, deposits are only refunded when you click the refund buttons.
Days to delay automatic refunds0 refunds as soon as the order is completed. Any other number (up to 30) waits that many days after completion before refunding – for example to allow time to inspect a returned item. Delayed refunds are processed by a twice-daily background task.
Make security deposit taxableWhen ticked, the deposit fee is taxed using the standard tax class, and the tax is refunded together with the deposit. Leave unticked if deposits are not taxable in your jurisdiction (the usual case, since the money is returned).
Security Deposit TitleThe name of the per-product deposit fee line in the cart, at checkout, on the order and in emails. [product_name] is replaced with the product’s name, so the default Security Deposit for [product_name] becomes Security Deposit for Canon EOS R6 Camera Rental. Leave it empty to use the default.

Cart Deposit Settings (per-order deposit) #

Instead of – or as well as – a deposit on each product, you can charge a single deposit for the whole order. The cart deposit is only added when the cart contains at least one product that has Use per order security deposit ticked in its Security Deposit tab (see Product Settings). Products with their own per-product deposit do not trigger it, and it is charged once per order no matter how many qualifying products are in the cart.

SettingWhat it does
Charge a per-order depositTurns the per-order deposit on. While it is off, products set to Use per order security deposit collect no deposit at all.
Per-order deposit nameThe name of the fee line in the cart totals, on the order and in emails. Default: Security Deposit.
Per-order deposit typeFixed value: the amount below is charged as it is. Percentage of qualifying cart items total: the amount below is a percentage of the subtotal of the products that use the per-order deposit (other products in the cart are not counted). Tiers by order subtotal (new in 1.0.9): the deposit depends on how big the order is. Set the bands in Per-order deposit tiers, below. While this is chosen, the single amount is hidden.
Per-order deposit amountThe fixed amount, or the percentage, depending on the type.
Per-order deposit tiersThe bands of the order subtotal, one row each. Shown only while the type is Tiers by order subtotal. See Deposit by order subtotal (tiers) below.

Deposit by order subtotal (tiers) #

A small order can take a small deposit and a big order a bigger one. Choose Tiers by order subtotal as the per-order deposit type, then add one row per band:

ColumnWhat it means
FromWhere the band starts. The band runs up to the next row’s “From”; the screen shows where each band ends (“up to $299.99”), and the last row says “and above”.
DepositThe deposit for an order in this band.
KindFixed amount (the deposit is charged as it is) or % of the subtotal.
Minimum / MaximumFor percentage rows only: the deposit never goes below the minimum or above the maximum. Leave either empty for none.

Click Add a band for another row and Remove to drop one. The rows are sorted by “From” when you save.

Example. A party rental shop wants $25 under $100, $50 from $100 to $299, $150 from $300 to $499, and 30% from $500 with a $150 minimum:

FromDepositKindMinimum
025Fixed amount
10050Fixed amount
300150Fixed amount
50030% of the subtotal150

An $80 order pays a $25 deposit, $250 pays $50, $400 or $450 pays $150, and $600 pays $180 (30%).

Good to know

  • The order still gets one deposit line, never one per item, and it is refunded apart from the rental charge. On the order screen you can refund it in full or keep part of it for damage or a late return, the same as any per-order deposit.
  • Only products set to Use per order security deposit count towards the subtotal. A product with its own per-product deposit, or no deposit, does not move the order into a higher band.
  • The band is picked from the subtotal before coupons, so a coupon lowers the rental, not the deposit.
  • On a store that shows prices with tax, the band is picked from the subtotal with tax, the way the cart shows it.
  • A kit or bundle counts at its full price when the kit, or one of the items in it, uses the per-order deposit.
  • An order below the first row’s “From” gets no deposit. Start the first row at 0 to cover every order.
  • The settings are refused, with a message, if two rows start at the same amount, a number is negative, a percentage is over 100, or a maximum is below its minimum. Nothing is saved until it is corrected.
  • If no bands are saved, no per-order deposit is added while this type is chosen (the screen says so).
  • Quotes and payment links (Request a Quote) and the Rental Counter charge the same bands as the checkout.

For developers: sisecuritydeposits_deposit_tiers filters the bands and sisecuritydeposits_tier_subtotal the subtotal a band is picked by. sisecuritydeposits_cart_deposit_amount still runs last on the amount.

How deposits appear to customers #

Deposits are added to the cart as fees, one line per product deposit plus one for the cart deposit, so they are shown in the cart totals and at checkout and are paid together with the order:

Deposit fee lines in the cart totals

The same lines appear in the order review at checkout, in the order emails and in My Account > Orders. Once a deposit has been refunded, the customer’s order view also lists the refund:

A customer's order in My Account after both deposits were refunded

Emails #

Two emails are sent whenever a deposit refund is issued (manually or automatically): Security Deposit Refunded to the customer and Security Deposit Refunded – Admin copy to the shop. Both are listed under WooCommerce > Settings > Emails, where you can disable them or change the subject, heading, recipient and additional content. WooCommerce’s own Refunded order email is not sent for deposit refunds, so the customer is not emailed twice.