Charges

Update a freeze period

Update an existing charge freeze period

put/charges/freeze-periods/{id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/charges/freeze-periods/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Freeze period ID

Request body

end_datestring date nullable
max_increase_percentagenumber nullable
legal_referencestring nullable
legal_document_urlstring nullable
descriptionstring nullable
conditionsobject nullable
exceptionsobject nullable

Response

Freeze period updated successfully

idstring uuid required
legislative_zone_idstring uuid required

Legislative zone this freeze applies to

service_category_idstring uuid required

Service category this freeze applies to

freeze_type'TOTAL_FREEZE' | 'PARTIAL_FREEZE' | 'INCREASE_LIMIT' | 'SEASONAL_FREEZE' required

Type of charge freeze period (Art. 17-2 Loi 89-462).

  • TOTAL_FREEZE: Complete freeze of all charge increases
  • PARTIAL_FREEZE: Partial freeze, some categories may still be adjusted
  • INCREASE_LIMIT: Maximum increase percentage applied
  • SEASONAL_FREEZE: Seasonal restriction on charge increases
start_datestring date required

Start date of the freeze period

end_datestring date nullable

End date of the freeze period (null = indefinite)

max_increase_percentagenumber nullable

Maximum allowed increase percentage (for INCREASE_LIMIT type)

legal_referencestring nullable

Legal text reference

legal_document_urlstring nullable

URL to the legal document

descriptionstring nullable

Human-readable description

conditionsobject nullable

Additional conditions for the freeze (JSON)

exceptionsobject nullable

Exceptions to the freeze (JSON)

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "freeze_type": "TOTAL_FREEZE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.