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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | string | Optional | ID of the worker who created this custom payout type. |
display_name | string | Required within parent | Display name of the payout type. |
id | string | Required within parent | Unique identifier of the payout type. Same as key. |
is_system | boolean | Required within parent | Whether this is a built-in payout type. |
key | string | Required within parent | Stable payout type key assigned by the server on create. |
mappings | array | Optional | Per-entity earning code mappings. |
mappings[] | Model | Each item | Expand Update a variable compensation payout type — response body — mappings item |
Referenced models: Update a variable compensation payout type — response body — mappings item