Skip to main content
PATCH
Update a currency offer
Changing currency_unit on an existing offer is usually not what you want. Create a new offer under the other unit instead. If you update currency_data, it must match the offer’s current unit schema from the template.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

currencyOffer
string
required

The ID of the currency offer. Can be retrieved from the list of currency offers.

Body

application/json

Update currency offer - all fields are optional, only provide fields you want to update

game_id
integer

Unique identifier for the game (required if game slug not provided)

game
string

Slug of the game (required if game_id not provided)

currency_unit
string

Currency unit slug from template.currency_units (e.g. fc-coins, fc-points). Optional.

Example:

"fc-points"

currency_unit_id
integer

Currency unit id. Alternative to currency_unit. Optional.

Example:

130

external_id
string

External identifier for the currency offer, used to map to your own system

Maximum string length: 255
description
string

Detailed description of the currency and how it will be delivered

Maximum string length: 5028
price
number

Price per currency unit, up to 6 decimal places. Interpreted in the currency specified by the currency field (defaults to EUR). USD values are converted to EUR before storage.

Example:

0.015

currency
enum<string>
default:EUR

Currency the price is expressed in. EUR is stored as-is; USD is converted to EUR server-side. Defaults to EUR.

Available options:
EUR,
USD
Example:

"EUR"

stock
integer

Available quantity of currency units in stock

Required range: 0 <= x <= 1000000000
Example:

1000000

min_quantity
integer
default:1

Minimum quantity that can be purchased in a single order

Required range: 1 <= x <= 1000000000
Example:

1000

volume_discounts
object[]

Optional volume discount tiers for currency games only (not top-ups). Max 3 tiers. Each tier percent is 1–50. Each tier min_quantity must be an integer >= 1, greater than the offer min_quantity, and unique across tiers. Omit to leave existing tiers unchanged. Send an empty array [] to remove all tiers. Only include this field when setting or clearing tiers. Sending this field for a top-up game returns 422 with error: "Volume discounts are only available for currency offers, not top-ups."

Maximum array length: 3
Example:
delivery_instructions
string

Special instructions for currency delivery, provided to buyer after purchase

delivery_method
enum<string> | null

Optional delivery method. If null, legacy currency precheckout behavior is used.

Available options:
none,
username,
login,
trade,
auction,
gift,
redeem,
mail
excluded_delivery_fields
enum<string>[] | null

Optional delivery fields disabled by the seller. Required fields for the selected method cannot be excluded.

Available options:
username,
server,
login,
password,
platform,
region
delivery_time
object

Expected delivery time object

Example:
currency_data
object

Game- and unit-specific attributes. Always load them from the template endpoint, passing the same currency_unit as the offer. If you update currency_data, it must match the offer's current unit schema from the template.

Example:

Response

A single currency offer

data
object

Currency offer object representing in-game currency for sale