Deel: Retrieve Benefits by Country — 200 response body — data item providers item
Retrieve Benefits by Country: 200 response body, field data / item / providers / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve Benefits by Country — 200 response body — data item providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item attachments item |
client_info | JSON | Optional | |
client_info (anyOf 1) | string | Alternative | Client information. |
client_info (anyOf 2) | null | Alternative | Client information. |
contribution_options | array | Required within parent | |
contribution_options[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item contribution options item |
country | string | Required within parent | Country code. |
currency | string | Required within parent | Currency. |
employee_info | JSON | Optional | |
employee_info (anyOf 1) | string | Alternative | Employee information. |
employee_info (anyOf 2) | null | Alternative | Employee information. |
home_page_url | string | Required within parent | The home page URL of the benefit provider. |
id | string | Required within parent | ID of the benefit provider. Format: uuid |
is_unisure | boolean | Required within parent | Indicates if Unisure. |
max_contribution | JSON | Optional | |
max_contribution (anyOf 1) | JSON | Alternative | |
max_contribution (anyOf 1) (anyOf 1) | number | Alternative | Maximum contribution. Format: double |
max_contribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_contribution (anyOf 2) | null | Alternative | Maximum contribution. Format: double |
min_contribution | JSON | Optional | |
min_contribution (anyOf 1) | JSON | Alternative | |
min_contribution (anyOf 1) (anyOf 1) | number | Alternative | Minimum contribution. Format: double |
min_contribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_contribution (anyOf 2) | null | Alternative | Minimum contribution. Format: double |
name | string | Required within parent | The name of the benefit provider. |
plans | array | Required within parent | |
plans[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item plans item |
type | string | Required within parent | Benefit type. |
Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item attachments item, Retrieve Benefits by Country — 200 response body — data item providers item contribution options item, Retrieve Benefits by Country — 200 response body — data item providers item plans item