> ## Documentation Index > Fetch the complete documentation index at: https://docs.omneo.io/llms.txt > Use this file to discover all available pages before exploring further. # Benefit Definitions ## What is a benefit definition? Much like achievement definitions, benefit definitions are a configurable 'template' used when adding a benefit. Use [Add Benefit Definition](/api-reference/benefit-definition/add-benefit-definition) to create a benefit definition. After this, you can then [Add Benefit](/api-reference/benefit/add-benefit) using your newly created definition. See [Benefits](/concepts/incentives/benefits) for a full explanation of how benefits work, including the claim and redemption lifecycle. ## Benefit definition properties | Attribute | Description | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id `INTEGER` `READ-ONLY` | The unique Omneo ID of the definition | | name `STRING` | The display name of the definition | | handle `STRING` | The unique handle for the definition | | period `INTEGER` | Valid for (in Days) | | description `STRING` | The internal description for the definition | | internal\_notes `STRING` | Internal notes against this definition | | short\_description `STRING` | A publicly available short description for this definition | | long\_description `STRING` | A publicly available full HTML description for this definition | | terms\_conditions `STRING` | Terms and conditions attached to this condition | | redeem\_instructions\_store `STRING` | Instructions to redeem in a physical store | | redeem\_instructions\_online `STRING` | Instructions to redeem online | | redeem\_code\_pos `STRING` | A redemption code used at the Point of Sale | | redeem\_code\_online `STRING` | A redemption code used Online | | icon `URL` | A valid URL for the icon associated with this definition | | image\_url `URL` | A valid URL for the cover image associated with this definition | | max\_redemptions `INTEGER` | The total redemptions available for an individual | | is\_extendable `BOOLEAN` | Denotes whether this definition's end date can be extended | | is\_assignable `BOOLEAN` | Denotes whether this definition can be assigned to an Omneo profile | | is\_reassignable `BOOLEAN` | Denotes whether this benefit can be reassigned once already assigned to a profile | | is\_published `BOOLEAN` | Denotes whether this benefit is published and is visible to the customer | | is\_archived `BOOLEAN` | Denotes whether this benefit has been archived, and no longer available for use | | tags `ARRAY` | An array of tags associated with the benefit | | is\_claimable `BOOLEAN` | Denotes whether this benefit can be claimed by a customer, this is different to redeeming. See [claiming benefits](/concepts/incentives/issue-claim-extend-redeem). | | max\_global\_redemptions `INTEGER` | The global maximum amount this benefit can be redeemed. | | total\_global\_redemptions\_remaining `INTEGER` | The amount of global redemptions remaining for this definition | | total\_global\_redemptions `INTEGER` | The amount of times this benefit has been redeemed | | total\_global\_created `INTEGER` | The amount of times this benefit has been assigned to a profile | | claim\_period\_start\_at `STRING` `DATE-TIME` | The start date when customers can begin claiming the benefit (if `is_claimable` is true) | | claim\_period\_end\_at `STRING` `DATE-TIME` | The end date when customers can no longer claim the benefit (if `is_claimable` is true) | | claim\_condition `ARRAY` | An array of attributes that must be available on the profile to be assigned. For example, the Tier must be level 2, or the Joined location must be specific. | | is\_reclaimable `BOOLEAN` | Denotes whether this benefit can be reclaimed by the same profile, once already claimed. | | notify\_schedule\_offset `INTEGER` | Offset the calculated schedule time from offset\_days, offset\_hours. this value is subtracted from the scheduled time (in hours) | | notify\_issue\_offset\_days `INTEGER` | An notification after the reward is issued Send X Days after the issue | | notify\_issue\_offset\_hour `INTEGER` | Send at X Hour of the day | | notify\_remind\_offset\_days `INTEGER` | An expiry reminder offset in days Send X Days after the `end_date` | | notify\_remind\_offset\_hour `INTEGER` | Send at X Hour of the day | | notify\_extend\_offset\_days `INTEGER` | An extension reminder usually sent before expiry Send X Days after the `end_date` | | notify\_extend\_offset\_hour `INTEGER` | Send at X Hour of the day | | remind\_target\_id `INTEGER` | the [target](ref:targets) id used when an reminder notification is triggered | | extend\_target\_id `INTEGER` | the [target](ref:targets) id used when an extension notification is triggered | | issue\_target\_id `INTEGER` | the [target](ref:targets) id used when an issued notification is triggered | | end\_at `INTEGER` | The end (or expiry) date of the definition | | total\_allocations `INTEGER` | The total allocations for this benefit | | total\_allocations\_remaining `INTEGER` | The total allocations remaining for this benefit | | force\_allocation `BOOLEAN` | If this flag is true, this benefit can only be assigned to a profile via an allocation. | | created\_at `STRING` `DATE-TIME` | The UTC date & time the benefit record was created in ISO 8601 format. | | updated\_at `STRING` `DATE-TIME` | The UTC date & time the benefit record was last updated in ISO 8601 format. |