Skip to content
Leadtime
English
Esc
↑↓navigate↵open⌘Jpreview

Create support contingent

Creates a new support contingent (retainer plan) for a project.

Required fields:

  • projectId: ID of the project
  • title: Name of the contingent plan
  • fromDate: Start date (ISO 8601 date format)
  • toDate: End date (ISO 8601 date format)
  • frequency: Frequency in months
  • price: Total price for the period
  • hours: Total hours allocated

Optional fields:

  • transferable: Whether unused hours can be transferred (default: false)

Validation:

  • Date periods must not overlap with existing contingents in the same project
  • Rate is automatically calculated as price / hours
  • All numeric values must be non-negative

Note: Requires WsSettings.manageSettings permission.

POST/administration/project-settings/support-contingents
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Request body
requiredapplication/json
frequencynumberrequired

Frequency in months for the contingent period

fromDatestringrequired

Start date of the contingent period (ISO 8601 date format)

hoursnumberrequired

Total hours allocated for the contingent period

pricenumberrequired

Total price for the contingent period

projectIdstringrequired

ID of the project this contingent belongs to (UUID)

titlestringrequired

Title or name of the support contingent plan

toDatestring

End date of the contingent period (ISO 8601 date format). If not set, the contingent is active forever.

transferableboolean

Whether unused hours can be transferred to the next period

Responses
201

Support contingent created successfully

successbooleanrequired

Operation success flag

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST "https://leadtime.app/api/public/administration/project-settings/support-contingents" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "frequency": 12,
  "fromDate": "2025-01-01",
  "hours": 120,
  "price": 10000,
  "projectId": "550e8400-e29b-41d4-a716-446655440001",
  "title": "Maintenance flatrate",
  "toDate": "2025-12-31",
  "transferable": false
}'
Response
{
  "success": true
}