Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIManagement APICheckout SessionsCreate a checkout session
POST/api/v1/checkout/sessions

Create a new checkout session. Returns a hosted-checkout URL to redirect the customer to.

See the Checkout Sessions overview for the full flow, prerequisites, and idempotency rules.

Headers

X-Api-Keystringrequired
Your API key.
Idempotency-Keystring
Optional idempotency key. Reusing it on an open session returns the same session.
Content-Typestringrequired
Must be application/json.

Body

itemsobject[]required
Items to purchase. 1–50 entries.
customerobjectrequired
Customer info.
couponCodestring
Optional discount coupon code.
giftCardCodestring
Optional gift card code.
successUrlstring· urlrequired
HTTPS, origin must be in allow-list. Supports {CHECKOUT_SESSION_ID} and {ORDER_ID} placeholders.
cancelUrlstring· urlrequired
HTTPS, origin must be in allow-list. Supports {CHECKOUT_SESSION_ID}.
clientReferenceIdstring
Your internal reference ID; max 255 chars; echoed back on the session.
expiresInSecondsinteger
Session expiry, 60–86400. Defaults to 3600 (1 hour).

items[]

packageIdstring· uuidrequired
Active package on this store.
quantityinteger
1–100, default 1.
serverIdstring· uuid
Required if the package has userServerSelectionEnabled.

customer

playerUsernamestringrequired
Player in-game name, 3–32 chars.
playerUuidstring· uuid
Minecraft UUID, optional.
emailstring· email
If absent, customer enters it at checkout.
OverviewRetrieve a checkout session