Skip to main content
POST
/
v1
/
leave-policies
Create a leave policy
curl --request POST \
  --url https://api.plane.com/v1/leave-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "type": "<string>",
  "effect": "<string>",
  "unit": "<string>",
  "applies": "<string>",
  "period": {},
  "accrual": {},
  "carryover": {},
  "balance": {},
  "usage": {},
  "payout": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Parameters

​
name
string
required
Human-readable policy name.
​
description
string
Plain-language explanation of the policy.
​
status
string
Lifecycle state for the policy. One of draft, active, or archived. Defaults to active.
​
type
string
required
Leave type, for example vacation or sick_time_off.
​
effect
string
required
Whether the policy is a set or add policy.
​
unit
string
required
Unit used for policy quantities. One of days or hours.
​
applies
string
Optional CEL expression used for automatic matching against the worker resource shape, for example worker.employment.location.address.country == "FR".
​
period
object
required
Period definition for the policy.
​
accrual
object
Optional accrual rule. Use null for unlimited leave.
​
carryover
object
Optional carryover rule. Use null for use-it-or-lose-it.
​
balance
object
Optional balance bounds. Use null for unlimited leave.
​
usage
object
Optional per-period usage cap.
​
payout
object
required
Termination payout rule.

​
Returns

Returns the created Leave Policy object.