A benefit of type custom.
Use it to grant any kind of benefit that doesn't fit in the other types.
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | ✔️ | The ID of the benefit. |
createdAt |
\DateTime | ✔️ | Creation timestamp of the object. |
modifiedAt |
\DateTime | ✔️ | Last modification timestamp of the object. |
type |
string | ✔️ | N/A |
description |
string | ✔️ | The description of the benefit. |
selectable |
bool | ✔️ | Whether the benefit is selectable when creating a product. |
deletable |
bool | ✔️ | Whether the benefit is deletable. |
isDeleted |
bool | ✔️ | Whether the benefit is deleted. |
organizationId |
string | ✔️ | The ID of the organization owning the benefit. |
metadata |
array<string, string|int|float|bool> | ✔️ | N/A |
properties |
Components\BenefitCustomProperties | ✔️ | Properties for a benefit of type custom. |