Rate Definitions API

Endpoints for managing rate definitions, assigning rates to products, calculating charges, and reading rate-engine metadata.

Endpoints#

Product Rates (nested)#

Calculation & Metadata#

Authentication#

Read endpoints require a Sanctum bearer token with the rates:read ability; write endpoints require rates:write. The calculate_rate endpoint accepts either rates:read or products:read, so product-scoped integrations can price without rate management access.

List Rate Definitions#

GET /api/v1/rate_definitions

Filters#

Includes#

Eager-load relationships with ?include=clonedFrom,productRates.

Response#

{
    "rate_definitions": [
        {
            "id": 1,
            "name": "Daily Rate",
            "description": "A flat charge for each day of the rental.",
            "calculation_strategy": "period",
            "calculation_strategy_name": "Period-based",
            "base_period": "daily",
            "base_period_name": "Daily",
            "enabled_modifiers": [],
            "strategy_config": {},
            "modifier_configs": {},
            "is_preset": true,
            "preset_slug": "daily-rate",
            "cloned_from_id": null,
            "created_at": "2026-01-15T14:30:00Z",
            "updated_at": "2026-01-15T14:30:00Z"
        }
    ],
    "meta": {
        "total": 11,
        "per_page": 20,
        "page": 1
    }
}

Create Rate Definition#

POST /api/v1/rate_definitions

Request Body#

{
    "name": "Daily with Tiers",
    "calculation_strategy": "period",
    "base_period": "daily",
    "description": "Daily rate with duration multipliers.",
    "enabled_modifiers": ["multiplier"],
    "strategy_config": { "day_type": "clock", "leeway_minutes": 60 },
    "modifier_configs": {
        "multiplier": { "tiers": [{ "multiplier": "1.0" }, { "multiplier": "0.9" }] }
    }
}

strategy_config and each entry in modifier_configs are validated against the composed schema for the chosen strategy and enabled modifiers. Hidden and disabled-modifier values are stripped before saving. Returns 201 Created with the rate definition object.

Duplicate Rate Definition#

POST /api/v1/rate_definitions/{id}/duplicate

Creates an editable copy named "{name} (Copy)" with is_preset false, preset_slug null, and cloned_from_id set to the source. Returns 201 Created.

Product Rates#

GET /api/v1/products/{product}/rates
POST /api/v1/products/{product}/rates

Request Body#

{
    "rate_definition_id": 1,
    "transaction_type": "rental",
    "price": 5000,
    "currency": "GBP",
    "store_id": null,
    "valid_from": "2026-01-01",
    "valid_to": null,
    "priority": 0
}

Note: price is sent in minor units (pence/cents) as an integer. Responses return it as a decimal string ("50.00").

Response#

{
    "product_rate": {
        "id": 7,
        "product_id": 1,
        "rate_definition_id": 1,
        "store_id": null,
        "transaction_type": "rental",
        "transaction_type_name": "Rental",
        "price": "50.00",
        "currency": "GBP",
        "valid_from": "2026-01-01",
        "valid_to": null,
        "priority": 0,
        "created_at": "2026-01-15T14:30:00Z",
        "updated_at": "2026-01-15T14:30:00Z"
    },
    "meta": {
        "overlapping_rate_ids": []
    }
}

meta.overlapping_rate_ids lists any existing rates that overlap the saved rate on store, transaction type, priority, and date window. Overlaps are permitted (resolved by priority at calculation time); the list is a non-blocking warning.

Calculate Rate#

POST /api/v1/products/{product}/calculate_rate

Resolves the highest-priority product rate for the given store, transaction type, and start date, then runs the rate engine over the rental window.

Request Body#

{
    "quantity": 2,
    "start": "2026-02-01T09:00:00Z",
    "end": "2026-02-06T17:00:00Z",
    "transaction_type": "rental",
    "store_id": null
}

Response#

{
    "rate_breakdown": {
        "currency": "GBP",
        "unit_price": "100.00",
        "units": 5,
        "unit_label": "days",
        "per_unit_subtotal": "500.00",
        "quantity": 2,
        "total": "1000.00",
        "line_items": [
            {
                "period_from": 1,
                "period_to": 5,
                "multiplier": "1.0",
                "unit_price": "100.00",
                "line_total": "500.00"
            }
        ],
        "applied_modifiers": []
    },
    "meta": {
        "resolved": true,
        "rate_definition_id": 1,
        "product_rate_id": 7
    }
}

Note: When no product rate is configured, the response is a zero-priced breakdown spanning the period and meta.resolved is false — products carry no standalone price, so this is an explicit "no rate configured" signal rather than a misleading amount.

Rate Engine Metadata#

These read-only endpoints expose the same data the framework uses to render its rate-definition form, so external builders can reproduce it.

GET /api/v1/rate_engine/strategies
GET /api/v1/rate_engine/modifiers
GET /api/v1/rate_engine/presets
GET /api/v1/rate_engine/schema?strategy=period&modifiers[]=multiplier

strategies reports each strategy's allowed_base_periods and whether it supports each modifier. schema requires a strategy and optional modifiers[], validates them against the registered set (422 on unknown values), and returns ordered form sections of fields.

RMS Rate Engine Mapping#

Signals presets mirror common industry-standard RMS engine types, so an imported product rate maps onto a preset of the same shape. Match the source RMS rate engine name to the preset slug below.

Note: Some RMS platforms offer a "Days Used Rate Engine" that depends on per-asset usage tracking, which is not implemented in this version. Such rates map to the Daily Rate preset as a documented fallback and can be revisited once usage data is available.