Rippling: Create hire — request body — body hires item compensation target bonus

API reference · Contract 2026-10-28

SDK schema: Create hire — request body — body hires item compensation target bonus

Field	Type	Presence	Description and constraints
$	object	Root	Bonus earned for meeting the role’s target performance. Express the target as exactly one of a monetary amount or a percentage of base pay; provide payment_frequency where required by GET /hire-requirements/. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields. Additional keys: not allowed
amount	object	Optional	Target bonus amount using currency_type as a three-letter ISO 4217 code and value as the decimal amount. Provide exactly one of amount or percent.
amount.currency_type	string	Optional	The currency type, ex: USD, EUR, etc.
amount.value	number	Optional	The decimal amount for the currency.
payment_frequency	string	Optional	How often the target bonus is paid: MONTH, QUARTER, SEMI_ANNUAL, or YEAR. Required when indicated by GET /hire-requirements/ for the selected country and hire type. One of: MONTH, QUARTER, SEMI_ANNUAL, YEAR
percent	string	Optional	Target bonus as a percentage of base pay, written as a numeric string without the percent sign, for example 15. Provide exactly one of amount or percent.