Command Reference

This page covers command formats, placeholders, and examples for all supported games.

Placeholders

Placeholders are replaced with actual values when commands are executed. Use them in your product delivery commands.

Universal Placeholders

These placeholders work across all games and plugins:

Placeholder	Description	Example Value
{player}	Player's game username	SurvivorSteve
{username}	Same as {player}	SurvivorSteve
{steam_id}	Player's Steam ID (64-bit)	76561198012345678
{quantity}	Quantity purchased	5
{product_name}	Name of the product	VIP Kit
{order_id}	Internal order ID	12345
{order_number}	Display order number	ORD-2025-0001
{customer_email}	Customer's email address	player@example.com
{customer_name}	Customer's display name	John Doe

TIP

The {order_number} placeholder is useful for server messages or logs to help customers reference their purchase. The {customer_email} and {customer_name} are filled from the customer's checkout information.

Using Placeholders

Place placeholders directly in your command text:

give {player} diamond_sword 1

When executed, this becomes:

give SurvivorSteve diamond_sword 1

Multiple Commands

Add multiple commands, one per line:

give {player} vip_sword 1
give {player} vip_armor 1
broadcast {player} just became a VIP!

Each command executes sequentially.

Command Types

Purchase Commands

Executed when a customer completes a purchase. Configure in product settings under Delivery > Commands.

give {player} purchased_item {quantity}

Refund Commands

Executed when you issue a refund. Configure in product settings under Delivery > Refund Commands.

take {player} purchased_item {quantity}

Chargeback Commands

Executed when a customer disputes the payment. Configure in product settings under Delivery > Chargeback Commands.

take {player} purchased_item {quantity}
ban {player} Payment chargeback

Subscription Cancel Commands

Executed when a subscription is canceled or expires. Configure in product settings under Delivery > Subscription Cancel Commands.

take {player} vip_rank
revoke {player} vip.permissions
notify {player} "Your subscription has ended."

When do subscription cancel commands run?

• Manual cancellation: When a customer or store owner cancels the subscription
• Payment failure: After failed renewal attempts exhaust (subscription becomes canceled)
• Expiration: When a subscription period ends without renewal
• Via sync jobs: Our system polls payment providers to detect status changes

Game-Specific Commands

Project Zomboid

Give Items:

additem {player} Base.Axe 1
additem {player} Base.RifleHunting 1
additem {player} Base.Bullets9mmBox {quantity}

Add Experience:

addxp {player} Strength 500
addxp {player} Fitness 500
addxp {player} Aiming 1000

Set Access Level:

setaccesslevel {player} admin
setaccesslevel {player} moderator
setaccesslevel {player} none

Server Messages:

servermsg "Welcome VIP member {player}!"
servermsg "{player} just purchased {product_name}!"

Teleport:

teleport {player} 1000 1000 0

Common Item IDs:

Category	Items
Weapons	Base.Axe, Base.BaseballBat, Base.RifleHunting, Base.Shotgun, Base.Pistol
Ammo	Base.Bullets9mmBox, Base.ShotgunShellsBox, Base.223Box
Medical	Base.FirstAidKit, Base.Bandage, Base.Pills
Tools	Base.Hammer, Base.Saw, Base.Wrench
Storage	Base.Bag_BigHikingBag, Base.Bag_DuffleBag
Building	Base.Plank, Base.NailsBox, Base.Generator

Rust

Give Items:

inventory.giveto {steam_id} wood 1000
inventory.giveto {steam_id} stones 1000
inventory.giveto {steam_id} metal.fragments 500

Give Weapons:

inventory.giveto {steam_id} rifle.ak 1
inventory.giveto {steam_id} ammo.rifle 128

Grant Permissions:

oxide.grant user {steam_id} vip.kit
oxide.grant user {steam_id} autoauth.use

Revoke Permissions:

oxide.revoke user {steam_id} vip.kit

Server Messages:

say {player} just purchased VIP status!

Common Item Shortnames:

Category	Items
Resources	wood, stones, metal.fragments, metal.refined, sulfur
Weapons	rifle.ak, rifle.bolt, smg.thompson, pistol.semiauto
Explosives	explosive.timed, rocket.launcher, ammo.rocket.basic
Building	wall.external.high, gates.external.high
Tools	pickaxe, hatchet, chainsaw
Medical	syringe.medical, largemedkit

Valheim

Spawn Items:

spawn Coins 100
spawn SwordIron 1
spawn ArmorBronzeChest 1

Spawn Multiple Items:

spawn SwordBlackmetal 1
spawn ShieldBlackmetal 1
spawn ArmorPaddedCuirass 1
spawn ArmorPaddedGreaves 1
spawn Coins 500

Common Item IDs:

Category	Items
Currency	Coins
Swords	SwordIron, SwordSilver, SwordBlackmetal
Axes	AxeIron, AxeBlackMetal
Bows	BowHuntsman, BowDraugrFang
Armor (Chest)	ArmorIronChest, ArmorWolfChest, ArmorPaddedCuirass
Armor (Legs)	ArmorIronLegs, ArmorWolfLegs, ArmorPaddedGreaves
Helmets	HelmetIron, HelmetDrake, HelmetPadded
Food	SerpentStew, LoxMeatPie, MeadHealthMajor
Resources	Iron, BlackMetal, DragonTear

Admin Commands

Rust Plugin

In-game commands (requires pixlpay.admin permission):

Command	Description
/pixlpay status	Show plugin status and connection info
/pixlpay poll	Force poll for pending commands
/pixlpay queue	Show pending deliveries
/pixlpay history [count]	Show command history
/pixlpay test	Test API connection
/pixlpay debug	Toggle debug mode
/pixlpay heartbeat	Send heartbeat to API

Valheim Plugin

No in-game commands. Configure via BepInEx config file.

Go Agent

Interactive mode commands (run with -interactive flag):

Command	Description
status	Show agent status and configuration
poll	Force immediate poll
queue	Show pending deliveries
history [count]	Show last N executed commands
test	Test API connection
debug	Toggle debug mode
heartbeat	Send heartbeat
help	Show all commands
quit	Stop the agent

Best Practices

Testing Commands

Always test commands before adding to products:

1. Test manually first - Run the exact command in your game console
2. Verify item IDs - Item IDs are case-sensitive in most games
3. Check placeholders - Make sure placeholder format is correct
4. Test with a real purchase - Do a test purchase to verify end-to-end

Command Design

Do:

• Keep commands simple and focused
• Test commands with different quantities
• Include error handling commands where possible
• Document what each command does

Don't:

• Use commands that might fail silently
• Assume player inventory has space
• Use admin-only commands that may break
• Chain too many commands together

Quantity Handling

The {quantity} placeholder is useful for stackable items:

give {player} diamonds {quantity}

For single items, use a literal 1:

give {player} special_sword 1

Refund, Chargeback & Subscription Cancel Commands

Always configure reversal commands for your products:

# Refund - remove items gently
take {player} purchased_item {quantity}
notify {player} "Your purchase has been refunded."

# Chargeback - remove items and potentially punish
take {player} purchased_item {quantity}
ban {player} "Payment disputed - contact support"

# Subscription Cancel - revoke ongoing benefits
revoke {player} vip.permissions
take {player} vip_rank
notify {player} "Your subscription has ended."

Important for Subscriptions

Subscription products should always have cancel commands configured. Without them, players keep their perks even after their subscription ends!

Troubleshooting

Command Not Working

1. Test the exact command in game console
2. Check for typos in item IDs
3. Verify placeholder syntax
4. Enable debug mode and check logs

Player Not Receiving Items

1. Check if player needs to be online
2. Verify player identifier is correct
3. Check inventory space
4. Look for error messages in logs

Multiple Commands Failing

1. Check if earlier command failed
2. Commands run sequentially - earlier failure may affect later ones
3. Test each command individually

Resources

• Project Zomboid Wiki
• Rust Item List
• Valheim Item IDs
• Troubleshooting Guide