Checkout
Creates a checkout session from a secure server using an API Key. If you have a Customer token, see the Storefront API Create Checkout endpoint.
Authorizations
Path parameters
storeIdstringRequired
Body
Request to create a new checkout session from your back-end server using the management API.
customer_id
needs to be specified explicitly here instead of using a Customer token.
subscriptionbooleanRequiredDeprecated
Whether this checkout creates a subscription. DEPRECATED: Use 'subscription' field in 'lines' array objects instead.
coupon_idstring · flake-idOptionalExample:
411486491630370816
affiliate_codestring | nullableOptional
Optional affiliate code to track referrals
return_urlstring | nullableOptional
Optional URL to redirect to after successful checkout
cancel_urlstring | nullableOptional
Optional URL to redirect to if checkout is canceled
auto_redirectbooleanRequired
Whether to automatically redirect the customer (return_url must be set)
customer_idstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
post
POST /v1/stores/{storeId}/checkouts HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1794
{
"lines": [
{
"subscription": true,
"gift_to": {
"platform": "invalid",
"id": "76561198152492642"
},
"gift_to_customer_id": "411486491630370816",
"quantity": 1,
"selected_gameserver_id": "411486491630370816",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"custom_variables": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"product_id": "411486491630370816",
"inline_product": {
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
"411486491630370816"
],
"gameservers": [
"411486491630370816"
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T18:50:43.338Z",
"enabled_until": "2025-08-01T18:50:43.338Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
}
],
"coupon_id": "411486491630370816",
"affiliate_code": "text",
"return_url": "text",
"cancel_url": "text",
"auto_redirect": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"customer_id": "411486491630370816"
}
{
"id": "411486491630370816",
"token": "text",
"url": "text"
}
Was this helpful?