Skip to main content

Overview

Returns the active pricing tiers used by the CleanLife pricing engine. Pricing tiers define pricing multipliers based on service duration (in minutes). Understanding these tiers allows you to replicate the price calculation logic on your own side or to display accurate pricing ranges to your customers.

Endpoint

GET /partners/pricing/tiers

Authentication

Requires a valid API Key with the partner_pricing_read permission.

Query Parameters

None.

Example Request

curl -X GET "https://apiv3.thecleanlife.dev/v1/partners/pricing/tiers" \
  -H "x-api-key: YOUR_API_KEY"

Success Response

HTTP Status: 200 OK
{
  "success": true,
  "data": [
    {
      "id": "eeeeeeee-0000-0000-0000-000000000001",
      "minMinutes": 120,
      "maxMinutes": 179,
      "factor": 1.0,
      "sorting": 1
    },
    {
      "id": "eeeeeeee-0000-0000-0000-000000000002",
      "minMinutes": 180,
      "maxMinutes": 239,
      "factor": 0.95,
      "sorting": 2
    },
    {
      "id": "eeeeeeee-0000-0000-0000-000000000003",
      "minMinutes": 240,
      "maxMinutes": null,
      "factor": 0.9,
      "sorting": 3
    }
  ]
}

Response Fields

FieldTypeDescription
idUUIDTier identifier
minMinutesintegerMinimum service duration (inclusive) in minutes for this tier to apply
maxMinutesinteger / nullMaximum service duration (inclusive) in minutes. null means “no upper limit”
factorfloatPrice multiplier. 1.0 = no discount; 0.9 = 10% discount
sortingintegerDisplay ordering — lower values appear first

Error Responses

HTTP StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENMissing partner_pricing_read permission

Notes

  • Pricing tiers are updated infrequently. Cache this response with a TTL of at least 1 hour.
  • The factor is applied to the base service price to determine the final price.
  • Use POST /partners/pricing/calculate-price to get an exact price for a specific booking configuration rather than computing it manually from tiers.

  • POST /partners/pricing/calculate-price — Calculate exact price for a booking configuration