# Purchasable Reward

Rewards that a player can purchase with his balance or experience.

* `price` \[number] - required price to buy
* `economy` \[text] - used economy plugin (or experience)
  * available options:
    * **Vault**
    * **PlayerPoints**
    * **TokenManager**
    * **Experience** - will use player exp

### Example configuration

{% code fullWidth="true" %}

```yaml
# Decides if rewards will be claimable.
enabled: true
type: purchasable_reward
#
# Reward tag
#
tag: Purchasable Reward
#
# Permission which player must have to be
# able to obtain this reward.
#
permission: ultimaterewards.examplePurchasable
#
# Which economy plugin to use.
# Available options:
#   Experience - will use player exp
#   Vault
#   TokenManager
#   PlayerPoints
#
economy: Experience
#
# Required balance to buy this reward.
#
price: 315 # 315 experience = 15 levels (table with levels you can find here:
#                                        https://minecraft.fandom.com/wiki/Experience#Leveling_up)
#
# NOTE THAT ITEM & SOUND NAMES ARE SLIGHTLY DIFFERENT BETWEEN >1.12 & 1.13< VERSIONS!
# SO MAKE SURE YOU ARE USING VALID ITEM NAMES (DEFAULT ONE ARE USED FROM 1.13+ VERSIONS)
# OTHERWISE WILL BE REPLACED BY STONE IF INVALID NAME IS IN USE.
#
# When player achieves the required amount of money,
# this version of reward item is displayed in the inventory:
#
available-item: "LIME_DYE"
available-display-name: "&a&lPURCHASABLE REWARD"
available-lore:
  - "&7You have enough experience"
  - "&7to obtain this reward!"
  - " "
  - "&7Contains:"
  - "&e 1x Totem Of Undying"
  - "&e 16x Golden Carrot"
  - " "
  - "&b► Click to claim for %amount% EXP"
#
# Whereas the player doesn't have enough required balance,
# this version of reward item is displayed in the inventory:
#
unavailable-item: "RED_DYE"
unavailable-display-name: "&c&lPURCHASABLE REWARD"
unavailable-lore:
  - "&7You need to collect"
  - "&7enough experience to be able obtain"
  - "&7this reward!"
  - " "
  - "&7Contains:"
  - "&7 1x Totem Of Undying"
  - "&7 16x Golden Carrot"
  - " "
  - "&4► Requires another %amount% EXP"
#
# When the player has already claimed this reward:
#
claimed-item: "GRAY_DYE"
claimed-display-name: "&7&lPURCHASABLE REWARD"
claimed-lore:
  - "&7Contains:"
  - "&7 &m1x Totem Of Undying"
  - "&7 &m16x Golden Carrot"
  - " "
  - "&7 Already claimed"
  - "&7 for %amount% EXP!"
#
# When the player doesn't have permission for this reward,
# the following properties will be shown.
#
no-permission-item: BARRIER
no-permission-display-name: "&c&l&mPURCHASABLE REWARD"
no-permission-lore:
  - "&c ✕ Locked, requires"
  - "&c   %permission% permission"
#
# Commands list that will be executed after the player
# obtains this reward.
# All available actions can be found at
# https://revivalo.gitbook.io/ultimaterewards/
#
# Format: () - optional value | [] - required value
#   [<actionType>] (<chance>):<command>
#
# Examples:
#   - [console] 50:give %player% diamond 1
#       - this command will have a 50%
#         execution chance due to its property value
#
#   - [message] "&aYou have claimed your %type% reward!"
#       - this action will send the player a message
#         with the defined content
#
# You can also use the random placeholders
# from the randoms.yml file and use them in commands.
# Example:
#   - give %player% iron_ingot %exampleRandom%
#       - the placeholder will be replaced by
#         a random number from the defined interval in randoms.yml
#
actions:
  - '[console] give %player% golden_carrot 16'
  - '[console] give %player% totem_of_undying 1'
  - '[console] say %player% claimed his %type% reward!'
  #  - '[actionbar] &aSuccessfully claimed!' # MenuAction bar can be used only from 1.12 versions!
  - '[title] &aClaimed'
  - '[subtitle] &aReward %type%'
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ultimaterewards.athelion.eu/configuration/rewards/reward-types/purchasable-reward.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.