$subtract

$subtract operator lets you subtract one value from another and return the result of the expression. You can use this in any Expression Object.

Syntax

{
    "$subtract": [<val_1>, <val_2>]
}

Properties

Field	Description	Required
<val_1>	The value to be subtracted from. The <val_1> can be any valid expression as long as it resolves to a number. It can also be a Magical Autocomplete.	true
<val_2>	The value to be subtracted from val_1 The <val_2> can be any valid expression as long as it resolves to a number. It can also be a Magical Autocomplete.	true

Returns

float - The result of $subtract operation

Examples

Basic example

{
    "$subtract": [10, 2]
}

The above expression returns 8.0

With Nested Expressions

{
    "$subtract": [
        {
            "$add": [1, 2]
        },
        4
    ]
}

The above expression calculates the nested expression, return 3 in its place and then the outer $subtract expression returns -1 overall.

With Magical Autocomplete

Let's say we have declared a variable temp in our API flow, which has a value of 5 currently.

{
    "$subtract": ["$.variables.temp", 3]
}

The above expression would resolve to a result of 2.0