Skip to main content
POST
/
admin
/
commission-rates
/
{id}
curl -X POST 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"value": 15, "is_enabled": true}'
{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Default",
    "code": "default",
    "type": "percentage",
    "value": 15,
    "is_enabled": true,
    "is_default": true,
    "rules": [],
    "values": []
  }
}
Updates a commission rate’s properties.
Rules are managed separately through the batch rules endpoint.

Path parameters

id
string
required
The commission rate’s ID.

Body parameters

name
string
The rate’s display name.
code
string
Unique code identifying the rate.
type
string
The rate type: fixed or percentage.
value
number
The commission value — a percentage or a fixed amount.
currency_code
string
Currency of a fixed rate’s value.
include_tax
boolean
Whether commission is calculated on tax-inclusive amounts.
include_shipping
boolean
Whether shipping is included in the commission base.
is_enabled
boolean
Whether the rate is active.
values
object[]
Per-currency fixed amounts.

Response

commission_rate
object
curl -X POST 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"value": 15, "is_enabled": true}'
{
  "commission_rate": {
    "id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
    "name": "Default",
    "code": "default",
    "type": "percentage",
    "value": 15,
    "is_enabled": true,
    "is_default": true,
    "rules": [],
    "values": []
  }
}