Skip to main content
PATCH
/
v1
/
auto_fee_protocol
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/auto_fee_protocol \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auto_fee_protocol": {
    "positive_checkout_fee_selection_strategy": "biggest"
  }
}
'
{
  "id": "66076ffc-8e99-4860-bdcc-1bb0bd704355",
  "object": "auto_fee_protocol",
  "negative_checkout_fee_selection_strategy": "all",
  "negative_line_item_fee_selection_strategy": "all",
  "negative_shipping_fee_selection_strategy": "all",
  "positive_checkout_fee_selection_strategy": "biggest",
  "positive_line_item_fee_selection_strategy": "all",
  "positive_shipping_fee_selection_strategy": "all",
  "created_at": 1767909671,
  "updated_at": 1767909671
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
auto_fee_protocol
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
negative_checkout_fee_selection_strategy
enum<string>

Determines how negative fees (discounts) applied at the checkout level are selected when multiple applicable fees exist. - all: Apply all matching fees. - biggest: Apply only the fee with the largest monetary impact. - lowest: Apply only the fee with the smallest monetary impact. - first: Apply the first matching fee based on creation order.

Available options:
all,
biggest,
lowest,
first
​
negative_line_item_fee_selection_strategy
enum<string>

Determines how negative fees (discounts) applied at the line-item level are selected when multiple applicable fees exist. - all: Apply all matching fees. - biggest: Apply only the fee with the largest monetary impact. - lowest: Apply only the fee with the smallest monetary impact. - first: Apply the first matching fee based on creation order.

Available options:
all,
biggest,
lowest,
first
​
negative_shipping_fee_selection_strategy
enum<string>

Determines how negative fees (discounts) applied to shipping are selected when multiple applicable fees exist. - all: Apply all matching fees. - biggest: Apply only the fee with the largest monetary impact. - lowest: Apply only the fee with the smallest monetary impact. - first: Apply the first matching fee based on creation order.

Available options:
all,
biggest,
lowest,
first
​
positive_checkout_fee_selection_strategy
enum<string>

Determines how positive fees applied at the checkout level are selected when multiple applicable fees exist. - all: Apply all matching fees. - biggest: Apply only the fee with the largest monetary impact. - lowest: Apply only the fee with the smallest monetary impact. - first: Apply the first matching fee based on creation order.

Available options:
all,
biggest,
lowest,
first
​
positive_line_item_fee_selection_strategy
enum<string>

Determines how positive fees applied at the line-item level are selected when multiple applicable fees exist. - all: Apply all matching fees. - biggest: Apply only the fee with the largest monetary impact. - lowest: Apply only the fee with the smallest monetary impact. - first: Apply the first matching fee based on creation order.

Available options:
all,
biggest,
lowest,
first
​
positive_shipping_fee_selection_strategy
enum<string>

Determines how positive fees applied to shipping are selected when multiple applicable fees exist. - all: Apply all matching fees. - biggest: Apply only the fee with the largest monetary impact. - lowest: Apply only the fee with the smallest monetary impact. - first: Apply the first matching fee based on creation order.

Available options:
all,
biggest,
lowest,
first
​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.