Service Rates

Service rates define sell-side pricing rules for delivery and logistics services. Use service rates to configure how quotes are calculated from distance, time, zones, service areas, and service types.

The Service Rate object

A service rate defines how Fleetbase prices a service within a service area or zone. It stores the calculation method, fee tiers, algorithm, COD and peak-hour surcharges, currency, and delivery estimates.

Attributes

idstringoptional

Public service rate identifier.

order_configstringoptional

Order configuration associated with the rate.

service_areaobjectoptional

Service area associated with the rate.

zoneobjectoptional

Zone associated with the rate.

service_namestringoptional

Service rate display name.

service_typestringoptional

Service type this rate applies to.

base_feecurrencyoptional

Base fee applied to the rate.

rate_calculation_methodstringoptional

Method used to calculate the rate.

rate_feesarray of objectsoptional

Distance or tiered fees.

parcel_feesarray of objectsoptional

Parcel-based fees.

algorithmstringoptional

Computable algorithm for algorithmic rates.

currencycurrencyoptional

Three-letter currency code.

duration_termsstringoptional

Human-readable delivery duration terms.

estimated_daysintegeroptional

Estimated service duration in days.

updated_attimestampoptional

Timestamp when the service rate was last updated.

created_attimestampoptional

Timestamp when the service rate was created.

The Service Rate object

{
  "id": "service_rate_8Qw2YxM3Nf",
  "order_config": "order_config_transport",
  "service_area": null,
  "zone": null,
  "service_name": "Standard Delivery",
  "service_type": "delivery",
  "base_fee": 500,
  "rate_calculation_method": "fixed_rate",
  "rate_fees": [],
  "parcel_fees": [],
  "currency": "USD",
  "duration_terms": "1-2 days",
  "estimated_days": 2,
  "updated_at": "2026-05-07T08:30:00.000000Z",
  "created_at": "2026-05-07T08:30:00.000000Z"
}

POST/v1/service-rates

Create a Service Rate

Create a Service Rate.

Body parameters

service_namestringrequired

Display name for the service rate.

service_typestringrequired

Service type this rate applies to.

service_areastringoptional

Service area ID this rate applies to.

zonestringoptional

Zone ID this rate applies to.

rate_calculation_methodenumrequired

Method used to calculate the rate. One of fixed_meter, fixed_rate, per_meter, per_drop, algo, parcel.

currencycurrencyrequired

Three-letter currency code.

base_feecurrencyoptional

Base fee applied to the rate.

per_meter_unitenumoptional

Distance unit for per_meter rates. One of km, m, ft, yd, mi.

per_meter_flat_rate_feecurrencyoptional

Flat fee per distance unit for per_meter rates.

meter_feesarray of objectsoptional

Distance fee tiers for fixed_meter or fixed_rate methods.

algorithmstringoptional

Computable algorithm used when rate_calculation_method is algo.

has_cod_feebooleanoptional

Whether the rate includes a cash-on-delivery fee.

cod_calculation_methodenumoptional

Cash-on-delivery fee calculation method. One of percentage, flat.

cod_flat_feecurrencyoptional

Flat cash-on-delivery fee.

cod_percentintegeroptional

Percentage cash-on-delivery fee.

has_peak_hours_feebooleanoptional

Whether the rate includes a peak-hours fee.

peak_hours_calculation_methodenumoptional

Peak-hours fee calculation method. One of percentage, flat.

peak_hours_flat_feecurrencyoptional

Flat peak-hours fee.

peak_hours_percentintegeroptional

Percentage peak-hours fee.

peak_hours_startstringoptional

Peak-hours start time in HH:mm format.

peak_hours_endstringoptional

Peak-hours end time in HH:mm format.

duration_termsstringoptional

Human-readable duration terms.

estimated_daysintegeroptional

Estimated service duration in days.

POST/v1/service-rates

curl -X POST https://api.fleetbase.io/v1/service-rates \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "service_name": "Food Delivery",
    "service_type": "food_delivery",
    "rate_calculation_method": "per_meter",
    "currency": "USD",
    "base_fee": 10.00,
    "per_meter_unit": "km",
    "per_meter_flat_rate_fee": 25,
    "has_cod_fee": true,
    "cod_calculation_method": "percentage",
    "cod_flat_fee": 1.00,
    "cod_percent": 0,
    "has_peak_hours_fee": true,
    "peak_hours_calculation_method": "percentage",
    "peak_hours_flat_fee": 3.00,
    "peak_hours_percent": 0,
    "peak_hours_start": "17:00",
    "peak_hours_end": "18:45",
    "duration_terms": "Standard",
    "estimated_days": 3
}'

GET/v1/service-rates

Query Service Rates

List all service rates.

Query parameters

limitintegeroptional

Maximum number of service rates to return.

offsetintegeroptional

Number of service rates to skip before returning results.

sortstringoptional

Sort expression for the service rate query.

service_areastringoptional

Filters service rates by service area ID.

zonestringoptional

Filters service rates by zone ID.

service_typestringoptional

Filters service rates by service type.

GET/v1/service-rates

curl https://api.fleetbase.io/v1/service-rates?limit=25&offset=0&currency=USD \
  -H "Authorization: Bearer flb_live_…"

GET/v1/service-rates/:id

Retrieve a Service Rate

Retrieves a service rate by ID.

GET/v1/service-rates/:id

curl https://api.fleetbase.io/v1/service-rates/:id \
  -H "Authorization: Bearer flb_live_…"

PUT/v1/service-rates/:id

Update a Service Rate

Update a Service Rate.

Body parameters

service_namestringoptional

Display name for the service rate.

service_typestringoptional

Service type this rate applies to.

service_areastringoptional

Service area ID this rate applies to.

zonestringoptional

Zone ID this rate applies to.

rate_calculation_methodenumoptional

Method used to calculate the rate. One of fixed_meter, fixed_rate, per_meter, per_drop, algo, parcel.

currencycurrencyoptional

Three-letter currency code.

base_feecurrencyoptional

Base fee applied to the rate.

per_meter_unitenumoptional

Distance unit for per_meter rates. One of km, m, ft, yd, mi.

per_meter_flat_rate_feecurrencyoptional

Flat fee per distance unit for per_meter rates.

meter_feesarray of objectsoptional

Distance fee tiers for fixed_meter or fixed_rate methods.

algorithmstringoptional

Computable algorithm used when rate_calculation_method is algo.

has_cod_feebooleanoptional

Whether the rate includes a cash-on-delivery fee.

cod_calculation_methodenumoptional

Cash-on-delivery fee calculation method. One of percentage, flat.

cod_flat_feecurrencyoptional

Flat cash-on-delivery fee.

cod_percentintegeroptional

Percentage cash-on-delivery fee.

has_peak_hours_feebooleanoptional

Whether the rate includes a peak-hours fee.

peak_hours_calculation_methodenumoptional

Peak-hours fee calculation method. One of percentage, flat.

peak_hours_flat_feecurrencyoptional

Flat peak-hours fee.

peak_hours_percentintegeroptional

Percentage peak-hours fee.

peak_hours_startstringoptional

Peak-hours start time in HH:mm format.

peak_hours_endstringoptional

Peak-hours end time in HH:mm format.

duration_termsstringoptional

Human-readable duration terms.

estimated_daysintegeroptional

Estimated service duration in days.

PUT/v1/service-rates/:id

curl -X PUT https://api.fleetbase.io/v1/service-rates/:id \
  -H "Authorization: Bearer flb_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "SGD",
    "base_fee": 12.66,
    "estimated_days": 6
}'

DELETE/v1/service-rates/:id

Delete a Service Rate

Delete a Service Rate.

DELETE/v1/service-rates/:id

curl -X DELETE https://api.fleetbase.io/v1/service-rates/:id \
  -H "Authorization: Bearer flb_live_…"