Skip to main content
POST
Create a checkout session for an offer

Authorizations

Authorization
string
header
required

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

Body

application/json
sku
string
required

Offer SKU to purchase.

Example:

"mc-java-17"

quantity
number
default:1
Required range: 1 <= x <= 100
Example:

1

planId
string

ID of the billing Plan to use. If omitted, the first (cheapest) active plan is used.

eggId
string

Selected egg variant (software choice, e.g. Velocity instead of the default Bungeecord). Must be the product default egg or one of its eggVariants; otherwise the checkout is rejected with a 400.

configs
object

Selected config options, keyed by configOptionId → chosen value (matching a choice value in the option's choices JSON array).

Example:
couponCode
string

Optional coupon code to apply at checkout. Validated against the Coupon table (must exist, be active, and not be expired).

Example:

"SUMMER25"

gatewayType
string

Gateway type to use for this checkout (e.g. "stripe", "manual"). When omitted, the default enabled gateway is used. A "manual" gateway leaves the invoice PENDING (awaiting payment) and returns no redirect URL.

Example:

"manual"

useCredits
boolean
default:false

When true, apply the customer account credit balance to the order, capped at loyalty.max_credit_usage_percent (default 50%) of the post-coupon total. The credits are deducted atomically and the remaining balance is charged via the gateway. The customer always pays at least (100 − max)% out of pocket.

Example:

true

Response

201 - undefined