# Income

The income system allows server administrators to set up automatic income rewards for users with specific roles. Users can claim these rewards periodically based on their roles.

## <mark style="color:red;">Server Admin Setup</mark>

### <mark style="background-color:red;">Add Role Income</mark>

`/config-income add <role> <reward_amount> <cooldown_per_user>`

Adds or updates income settings for a specific role.

* **role**: The role to set income reward for
* **reward\_amount**: Amount of currency to reward (1 to 1,000,000)
* **cooldown\_per\_user**: Time between claims in days (0.01 to 365)

<figure><img src="https://830634877-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0OjTorGMztj18rxBEu9d%2Fuploads%2FQl8ZK3iwHdpUQC691yc8%2Fimage.png?alt=media&#x26;token=2cba1937-3434-4ca4-be97-2b9bae2e2a1b" alt=""><figcaption></figcaption></figure>

### <mark style="background-color:red;">Remove Role Income</mark>

`/config-income remove <role>`

Removes income settings for a specific role.

Example: `/config-income remove @Founder`

<figure><img src="https://830634877-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0OjTorGMztj18rxBEu9d%2Fuploads%2FriFTMb5YqgoXETNRERtT%2Fimage.png?alt=media&#x26;token=8dc48fc6-8da0-4d87-907c-d3c2dab196fb" alt=""><figcaption></figcaption></figure>

### <mark style="background-color:green;">Claim Income</mark>

`/income claim`

Claims income from all your eligible roles at once.

Features:

* Claims rewards from all roles you have that are configured for income
* Shows how much you earned from each role
* Displays when you can claim from each role again
* Has a 10-minute cooldown between command uses

Example Response:

<figure><img src="https://830634877-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0OjTorGMztj18rxBEu9d%2Fuploads%2FOuOmZWBqzuWU1Ncw04Ai%2Fimage.png?alt=media&#x26;token=142f4158-9266-4d3e-b456-3bfcc92bd7fb" alt=""><figcaption></figcaption></figure>

### <mark style="background-color:green;">View Role Incomes</mark>

`/income view`

Displays all currently configured role incomes in the server.

<figure><img src="https://830634877-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0OjTorGMztj18rxBEu9d%2Fuploads%2F61hCXjNA4QBdZv9AyDnc%2Fimage.png?alt=media&#x26;token=4afad882-7265-4c04-8b39-b5807e46055b" alt=""><figcaption></figcaption></figure>

### Important Notes

* Maximum of 5 role incomes can be configured per server
* Each role has its own independent cooldown
* You can claim from multiple roles at once
* The command has a 10-minute cooldown between uses
* You must have the role to claim its income
* Income is added to your checking balance
