Deel: Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution
Retrieve Benefits for Employee: 200 response body, field data / item / benefits / item / employee_contribution. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Recurring portion of plan cost collected from the employee’s pay for this benefit. Expressed with calculation metadata (`type`, `value`), resolved `amount`, `currency`, and `frequency`. For a given period, `employee_contribution.amount` plus `employer_contribution.amount` reflects the split of premium or plan cost represented here; use `enrollment_details` cycle fields when you need billed totals for the current cycle. |
amount | JSON | Required within parent | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | number | Alternative | Resolved employee contribution in `currency` for each `frequency` period (for example `100` with `USD` and `MONTHLY` means one hundred US dollars per month). Format: double |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | Resolved employee contribution in `currency` for each `frequency` period (for example `100` with `USD` and `MONTHLY` means one hundred US dollars per month). Format: double |
currency | string | Required within parent | ISO 4217 currency code for `amount` (for example USD, CAD, GBP). Matches the parent contract’s `currency` for this benefits payload. |
frequency | JSON | Required within parent | |
frequency (anyOf 1) | string | Alternative | Payroll or billing cadence for this contribution. Typical values include MONTHLY, SEMI_MONTHLY (twice per month), BIWEEKLY, WEEKLY, and ANNUALLY; exact strings follow Deel payroll configuration. |
frequency (anyOf 2) | null | Alternative | Payroll or billing cadence for this contribution. Typical values include MONTHLY, SEMI_MONTHLY (twice per month), BIWEEKLY, WEEKLY, and ANNUALLY; exact strings follow Deel payroll configuration. |
type | JSON | Required within parent | |
type (anyOf 1) | string | Alternative | How the employee contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis defined by the plan. Additional values (for example employer match shapes on retirement benefits) can appear for specialized products. |
type (anyOf 2) | null | Alternative | How the employee contribution is derived. FIXED_AMOUNT = flat currency per `frequency`. PERCENTAGE = percent of an earnings or cost basis defined by the plan. Additional values (for example employer match shapes on retirement benefits) can appear for specialized products. |
value | JSON | Required within parent | Raw contribution input from configuration or upstream systems; may be a number or string (for example `“1.23”`). Use `amount` for display and arithmetic — it is the normalized numeric value in `currency` per `frequency`. |
value (anyOf 1) | JSON | Alternative | |
value (anyOf 1) (anyOf 1) | Model | Alternative | Expand Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution value value value |
value (anyOf 1) (anyOf 2) | null | Alternative | |
value (anyOf 2) | null | Alternative |
Referenced models: Retrieve Benefits for Employee — 200 response body — data item benefits item employee contribution value value value