Manage on-call pay configs: the rates that pay reports price on-call shifts against.
The pay config object
A pay config sets what someone is paid for being on call: a base rate,
plus rules that override it at particular times. An on-call pay report prices
each person's shifts against one.
Rules are evaluated in the order they are returned, and the first one that
covers a shift wins. Any time no rule covers is paid at the base rate.
base_rate_cents
integer<int64>
required
Rate paid for one unit of rate_time_unit, for any time no rule covers, in the lowest denomination of the currency
Example:
1200
created_at
string<date-time>
required
Example:
"2021-08-17T13:28:57.801578Z"
currency
string
required
Currency this config pays in, in ISO 4217 format
Example:
"GBP"
id
string
required
Unique identifier for this pay config
Example:
"01G0J1EXE7AXZ2C93K61WBPYEH"
name
string
required
Human readable name for this pay config
Example:
"Engineering on-call"
one_off_rules
object[]
required
Rules that apply over a single window of time, such as a public holiday
The unit of time every rate on this config is quoted per: hour, day, or week. A day is 24 hours of shift time and a week is 7 days. Pay is pro-rated by the second.
Available options:
hour,
day,
week
Example:
"hour"
timezone
string
required
IANA timezone this config's rules are interpreted in
Example:
"Europe/London"
updated_at
string<date-time>
required
Example:
"2021-08-17T13:28:57.801578Z"
weekly_rules
object[]
required
Rules that apply every week, by day of week and time of day, in evaluation order. Must be empty when rate_time_unit is week.