Commission Rates
Retrieve Commission Rate
Retrieve a commission rate by ID.
GET
/
admin
/
commission-rates
/
{id}
curl 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { commission_rate } = await client.admin.commissionRates.$id.query({
$id: "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"commission_rate": {
"id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"name": "Default",
"code": "default",
"type": "percentage",
"value": 10,
"currency_code": null,
"include_tax": false,
"include_shipping": false,
"is_enabled": true,
"is_default": true,
"rules": [],
"values": []
}
}
Returns a single commission rate with its rules and per-currency values.
Path parameters
string
required
The commission rate’s ID.
Query parameters
string
Comma-separated fields to include in the response.
Response
object
Show properties
Show properties
string
The commission rate’s ID.
string
The rate’s display name.
string
The rate’s unique code.
string
The rate type:
fixed or percentage.number
The commission value.
string | null
Currency of a fixed rate’s value.
boolean
Whether commission is calculated on tax-inclusive amounts.
boolean
Whether shipping is included in the commission base.
boolean
Whether the rate is active.
boolean
Whether this is the marketplace default rate.
object[]
Rules scoping the rate, each with
id, reference, and reference_id.object[]
Per-currency fixed amounts, each with
id, currency_code, and amount.string
Creation timestamp.
string
Last update timestamp.
curl 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { commission_rate } = await client.admin.commissionRates.$id.query({
$id: "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"commission_rate": {
"id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"name": "Default",
"code": "default",
"type": "percentage",
"value": 10,
"currency_code": null,
"include_tax": false,
"include_shipping": false,
"is_enabled": true,
"is_default": true,
"rules": [],
"values": []
}
}
⌘I
curl 'http://localhost:9000/admin/commission-rates/comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y' \
-H 'Authorization: Bearer <token>'
const { commission_rate } = await client.admin.commissionRates.$id.query({
$id: "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
})
{
"commission_rate": {
"id": "comrate_01HXYZ8Q2M4N6P8R0T2V4W6X8Y",
"name": "Default",
"code": "default",
"type": "percentage",
"value": 10,
"currency_code": null,
"include_tax": false,
"include_shipping": false,
"is_enabled": true,
"is_default": true,
"rules": [],
"values": []
}
}