Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIWebhooksEventsOrder Created
POSTorder.created

Sent when a new order has been placed, before payment is confirmed.

On a gift order, player_username remains the purchaser, not the recipient. An integration that announces “{player_username} bought {package}” stays accurate about who paid, but names the wrong player as the beneficiary. Read recipient_username when it is present to find out who the goods actually went to.

data

order_idstring· uuid
The order ID.
checkout_session_idstring· uuid
Checkout session that produced this order.
player_usernamestring
Player in-game name of the purchaser. See the note above on gift orders.
player_uuidstring· uuid
Minecraft UUID of the purchaser, if known.
recipient_usernamestring | null
Player who received the goods, when the order was a gift. Null otherwise.
recipient_uuidstring | null
Recipient’s Minecraft UUID, if known. Null when the order is not a gift.
total_amountnumber
Final amount paid.
currencystring
ISO 4217 currency code.
itemsobject[]
Line items in the order.

items[]

package_idstring· uuid
Package ID.
package_namestring
Package name at time of purchase.
quantityinteger
Quantity purchased.
pricenumber
Per-unit price at purchase.

On a gift order, player_username is still the purchaser, and the recipient fields are populated:

{
  "order_id": "e5f6a7b8-...",
  "checkout_session_id": "c1d2e3f4-...",
  "player_username": "Steve",
  "player_uuid": "069a79f4-...",
  "recipient_username": "Bob",
  "recipient_uuid": "b1d4a7f2-...",
  "total_amount": 9.99,
  "currency": "USD",
  "items": [
    {
      "package_id": "c1d2e3f4-...",
      "package_name": "VIP Rank",
      "quantity": 1,
      "price": 9.99
    }
  ]
}

FluxStore sends this payload as an HTTP POST to your configured webhook URL.

Order CompletedPayment Declined