Skip to main content
PUT
/
v1
/
instance
/
{identifier}
/
tax
Collect taxes for an instance
curl --request PUT \
  --url https://api.pixocracy.io/v1/instance/{identifier}/tax \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "application": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "instances": [
      {}
    ],
    "twitchUsername": "<string>",
    "featuredInstance": {}
  },
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxRate": 123,
  "collectedTaxes": 123,
  "npcs": [],
  "agentNpcs": []
}
Billable Resource
Initiate a tax collection event in your instance. This will collect taxes from all Agent NPCs based on the current tax rate. Tax collection affects the wealth of your Agent NPCs and contributes to your instance’s treasury. The amount collected is determined by each Agent NPC’s current wealth and the instance’s tax rate.

Authorizations

​
Authorization
string
header
required

Your Application's JWT token

Path Parameters

​
identifier
string
required

The ID or UUID of the instance

Response

The updated instance

​
id
string<uuid>
required

Unique identifier

​
createdAt
string<date-time>
required

Date of creation

​
updatedAt
string<date-time>
required

Date of last update

​
application
object
required

The application that the instance belongs to.

​
uuid
string<uuid>
required

The UUID of the instance.

​
taxRate
number
required

The tax rate of the instance.

​
collectedTaxes
number
required

The amount of taxes collected by the instance.

​
deletedAt
string<date-time> | null

Date of deletion

​
npcs
object[]

The NPCs of the instance.

​
agentNpcs
object[]

The agent NPCs of the instance.