Skip to content

Rippling: List variable compensation payout types — response body — results item

List variable compensation payout types: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: List variable compensation payout types — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
created_bystringOptionalID of the worker who created this custom payout type.
display_namestringRequired within parentDisplay name of the payout type.
idstringRequired within parentUnique identifier of the payout type. Same as key.
is_systembooleanRequired within parentWhether this is a built-in payout type.
keystringRequired within parentStable payout type key assigned by the server on create.
mappingsarrayOptionalPer-entity earning code mappings.
mappings[]ModelEach itemExpand Update a variable compensation payout type — response body — mappings item

Referenced models: Update a variable compensation payout type — response body — mappings item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.