Benefit Multiplier Config Repository - API Contract

GET /api/v1/benefit-multiplier-configs/api/v1/benefit-multiplier-configs

List all multiplier configs across all organisations

Public

Response Example

{
  "data": [
    {
      "organisation_id": "org_42",
      "cost_per_session": 3.5,
      "cost_per_hour": 30,
      "health_system_multiplier": 1,
      "cached": true,
      "last_refreshed_at": "2026-03-25T08:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

GET /api/v1/benefit-multiplier-configs/api/v1/benefit-multiplier-configs/:organisation_id

Get the multiplier config for a specific organisation

Public

Response Example

{
  "organisation_id": "org_42",
  "cost_per_session": 3.5,
  "cost_per_hour": 30,
  "health_system_multiplier": 1,
  "cached": true,
  "last_refreshed_at": "2026-03-25T08:00:00Z"
}

POST /api/v1/benefit-multiplier-configs/api/v1/benefit-multiplier-configs

Create a multiplier config for a new organisation

Public

Request Example

{
  "organisation_id": "org_99",
  "cost_per_session": 5,
  "cost_per_hour": 35,
  "health_system_multiplier": 1.2
}

Response Example

{
  "organisation_id": "org_99",
  "cost_per_session": 5,
  "cost_per_hour": 35,
  "health_system_multiplier": 1.2,
  "cached": false,
  "last_refreshed_at": "2026-03-26T09:00:00Z"
}

PUT /api/v1/benefit-multiplier-configs/api/v1/benefit-multiplier-configs/:organisation_id

Update the multiplier config for an organisation

Public

Request Example

{
  "cost_per_session": 4,
  "cost_per_hour": 32,
  "health_system_multiplier": 1.1
}

Response Example

{
  "organisation_id": "org_42",
  "cost_per_session": 4,
  "cost_per_hour": 32,
  "health_system_multiplier": 1.1,
  "cached": true,
  "last_refreshed_at": "2026-03-26T09:05:00Z"
}

DELETE /api/v1/benefit-multiplier-configs/api/v1/benefit-multiplier-configs/:organisation_id

Delete the multiplier config for an organisation

Public

Response Example

{
  "deleted": true,
  "organisation_id": "org_42"
}

POST /api/v1/benefit-multiplier-configs/api/v1/benefit-multiplier-configs/:organisation_id/refresh

Force refresh the cached multiplier config from the source of truth

Public

Response Example

{
  "organisation_id": "org_42",
  "cost_per_session": 3.5,
  "cost_per_hour": 30,
  "health_system_multiplier": 1,
  "cached": true,
  "last_refreshed_at": "2026-03-26T09:10:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}