PayNow

Checkout

Create a checkout session

POSThttps://api.paynow.gg/v1/stores/{storeId}/checkouts

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.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdstringRequired
Request body
customer_idFlakeIdRequired
linesCreateCheckoutSessionLineManagementDto[]Required
The line items to include in the checkout
quantityintegerRequired
The quantity of this product to purchase
custom_variablesobjectOptional
Key-value pair mapping custom variable identifiers to their selected values. Required only when the product includes custom variables.
gift_toCustomerPlatformAccountDtoOptional
Represents a customer platform association, used for gifting
idstringRequired
The account ID on the platform
platformenumRequired
Possible enum values
  • invalid
  • steam

    Steam profile platform - the ID param must be a Steam ID 64.

  • minecraft

    Minecraft profile platform - the ID param must be a Minecraft nick. If your store platform is Geyser, this automatically sets the Minecraft platform based on the prefix configured in store settings.

  • paynow_name

    PayNow name profile platform - the ID param must be a PayNow username.

  • paynow

    PayNow name profile platform - the ID param must be a PayNow username.

  • minecraft_java_name

    Minecraft Java Profile Platform - the ID param must be a Java minecraft nick.

  • minecraft_bedrock_name

    Minecraft Bedrock Profile Platform - the ID param must be a Bedrock minecraft nick.

  • xbox_xuid

    Minecraft Xbox XUID Profile Platform - the ID param must be an xbox xuid

  • minecraft_uuid

    Minecraft profile platform - the ID param must be a Minecraft UUID.

gift_to_customer_idFlakeIdOptional
inline_productInlineProductCreateDtoOptional
Optional inline product definition for dynamic products. Requires special approval, use `product_id` instead.
allow_concurrent_active_itemsbooleanOptional
Indicates whether concurrent active items are allowed.
allow_one_time_purchasebooleanOptional
Indicates whether one-time purchases are allowed.
allow_subscriptionbooleanOptional
Indicates whether subscription purchases are allowed.
commandsProductCommandDto[]Optional
The commands to be executed at different stages.
→ ProductCommandDto
custom_variable_idsFlakeId[]Optional
The IDs of associated custom variables.
customer_stock_limitProductStockLimitDtoOptional
→ ProductStockLimitDto
deliverable_actionsProductDeliverableActionsDtoOptional
→ ProductDeliverableActionsDto
descriptionstringOptional
The detailed description of the product.
enabled_atstringOptional
The date and time when the product becomes enabled. Set to `null` to keep enabled.
enabled_untilstringOptional
The date and time until which the product remains enabled. Set to `null` to keep enabled.
gameserversFlakeId[]Optional
The gameserver IDs associated with the product.
is_affiliate_links_disabledbooleanOptional
Indicates if applying affiliate links should be disabled on the product.
is_coupons_disabledbooleanOptional
Indicates if applying coupons should be disabled on the product.
is_gift_cards_disabledbooleanOptional
Indicates if applying gift cards should be disabled on the product.
is_gifting_disabledbooleanOptional
Indicates whether gifting is disabled.
is_hiddenbooleanOptional
Indicates whether the product is hidden.
labelstringOptional
The display label for the product.
metadataobjectOptional
Additional metadata for the product.
namestringOptional
The display name of the product.
payout_splitsProductPayoutSplitDto[]Optional
The payout splits for revenue distribution. Requires special approval.
→ ProductPayoutSplitDto
priceintegerOptional
The price of the product in the lowest denominator (e.g. cents).
remove_after_enabledbooleanOptional
Indicates whether automatic removal is enabled.
remove_after_time_scaleenumOptional
Possible enum values
  • invalid
  • day
  • week
  • month
remove_after_time_valueintegerOptional
The time value for automatic removal.
required_product_allbooleanOptional
Indicates whether all required products are needed.
required_product_idsFlakeId[]Optional
The IDs of products required for purchasing this product.
single_game_server_onlybooleanOptional
Indicates whether the customer is prompted to select a game server before purchasing.
slugstringOptional
The unique URL-safe identifier (slug) for the product.
stock_limit_do_not_include_removedbooleanOptional
Indicates whether removed items should be excluded from stock limits.
store_stock_limitProductStockLimitDtoOptional
→ ProductStockLimitDto
subscription_interval_scaleenumOptional
Possible enum values
  • invalid
  • day
  • week
  • month
  • year
subscription_interval_valueintegerOptional
The subscription interval value.
tagsFlakeId[]Optional
The tag IDs associated with the product.
tax_codeenumOptional
Determines the category of the product for taxation purposes. Contact support for help with setting the correct tax code.
Possible enum values
  • unknown

    Unknown tax code.

  • digital_goods_subscription

    You provide customers access to photographs, audiovisual works, audio works, and books, delivered electronically to a customer for non-permanent access, with right of use conditioned on continued payment to the seller.

  • digital_goods_permanent

    You provide customers access to photographs, audiovisual works, audio works, and books, delivered electronically to a customer.

  • saas

    SaaS: Pre-written software, delivered electronically. You provide customers access to a hosted software application, described as computer programs designed to permit the user to perform a group of coordinated functions, tasks, or activities. You are typically responsible for all aspects of making the software service available.

  • downloaded_software

    Pre-written, non-custom computer software that is delivered electronically for download onto customers' devices/servers. No tangible personal property (e.g. CD-ROM, etc.) is delivered or used in conjunction with the download.

  • digital_goods_subscription_gaming

    Cloud based or downloaded access to digital gaming services (used by default for game servers).

  • digital_goods_permanent_gaming

    Permanent digital goods for gaming (not recommended).

  • iaas

    Infrastructure as a Service: Providing users remote access to data center equipment and computing power.

  • paas

    Platform as a Service: A cloud computing service bundle that includes both the infrastructure (servers, storage, and networking) and the middleware (development tools, business intelligence services, database management systems) that provides the customer a complete development and deployment environment in the cloud.

  • saas_security

    Cloud-based SaaS, designed to secure customer data. Pre-written software, delivered electronically, designed specifically to provide protection of computer systems, software, or data against unauthorized access or intrusion. This includes separately charged maintenance and updates delivered electronically, whether included in the cost of the software or charged as a separate line item.

  • saas_storage

    Cloud-based SaaS, designed to backup customer data. Pre-written software, delivered electronically, designed purely as storage for a customer's data. You provide customers access to a software product solely to facilitate the storage of digital products, digital codes, computer software or master copies of software. This includes separately charged maintenance and updates delivered electronically, whether included in the cost of the software or charged as a separate line item.

tier_group_idFlakeIdOptional
trialUpsertProductTrialConfigurationDtoOptional
→ UpsertProductTrialConfigurationDto
upsellingUpsertProductUpsellConfigurationDtoOptional
→ UpsertProductUpsellConfigurationDto
metadataobjectOptional
Optional metadata to associate with the checkout session line. Do not store any sensitive information here.
payout_splitsCreateCheckoutSessionLineManagementPayoutSplitDto[]Optional
Optional payout splits for line items (requires approval)
payout_idstringRequired
The ID of the user's payout balance.
percentageintegerOptional
The percentage of the line amount this user receives (in basis points, e.g., 5000 = 50%) NOTE: The last payout split needs to have a null percentage set (so the remaining amount gets properly allocated)
platform_feeintegerOptional
The platform fee percentage applied to this split (in basis points) Only applicable to platforms.
product_idFlakeIdOptional
selected_gameserver_idFlakeIdOptional
subscriptionbooleanOptional
Determines whether this line should create a subscription
trialbooleanOptional
Indicates whether the product should be trialed
affiliate_codestringOptional
Optional affiliate code to track referrals. An invalid affiliate code will NOT cause an error.
auto_redirectbooleanOptional
Whether to automatically redirect the customer (return_url must be set)
cancel_urlstringOptional
Optional URL to redirect to if checkout is canceled
coupon_idFlakeIdOptional
customer_detailsCheckoutCustomerDetailsDtoOptional
The billing details of the customer the checkout belongs to.
billing_addressAddressDtoOptional
Represents a physical or billing address
citystringOptional
The city of the address
countrystringOptional
The country of the address
line_1stringOptional
The first line of the street address
line_2stringOptional
The second line of the street address, if any (apartment, suite, etc.)
postal_codestringOptional
The postal code or zip code of the address
statestringOptional
The state or province of the address
billing_emailstringOptional
The email address the checkout is billed to.
billing_namestringOptional
The name the checkout is billed to.
billing_tax_idstringOptional
The tax identifier of the customer, such as a VAT number.
metadataobjectOptional
Optional metadata to associate with the checkout session. Do not store any sensitive information here.
promo_codesstring[]Optional
Optional array of promo codes (coupons, gift cards, affiliates) to apply. An invalid promo code will cause an error.
return_urlstringOptional
Optional URL to redirect to after successful checkout
Response
200OKCreateCheckoutSessionResponseDto
Response after creating a checkout session
Show fields
idFlakeIdRequired
tokenstringRequired
The token for the checkout session
urlstringRequired
The URL to redirect the customer to complete checkout

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/checkouts" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "411486491630370816",
  "lines": [
    {
      "quantity": 0,
      "subscription": true,
      "trial": true,
      "gift_to": {
        "id": "76561198152492642",
        "platform": "invalid"
      },
      "gift_to_customer_id": "411486491630370816",
      "selected_gameserver_id": "411486491630370816",
      "custom_variables": {},
      "product_id": "411486491630370816",
      "inline_product": {
        "slug": "string",
        "name": "string",
        "description": "string",
        "label": "string",
        "price": 0,
        "single_game_server_only": true,
        "allow_one_time_purchase": true,
        "allow_subscription": true,
        "subscription_interval_value": 0,
        "subscription_interval_scale": "invalid",
        "trial": {
          "enabled": true,
          "period_value": 0,
          "period_scale": "invalid",
          "revoke_immediately_when_canceled": true,
          "new_customers_only": true,
          "new_customer_order_lookback_value": 0,
          "new_customer_order_lookback_scale": "invalid",
          "allow_repeat_trials": true,
          "repeat_trial_cooldown_value": 0,
          "repeat_trial_cooldown_scale": "invalid"
        },
        "upselling": {
          "enabled": true,
          "recommendations": [
            {
              "discount_amount": 0,
              "discount_type": "unknown",
              "prefer_as_subscription": true,
              "recommended_product_id": "411486491630370816",
              "type": "unknown",
              "minimum_base_product_quantity": 0,
              "minimum_recommended_product_quantity": 0,
              "quantity_to_add": 0
            }
          ]
        },
        "remove_after_enabled": true,
        "remove_after_time_value": 0,
        "remove_after_time_scale": "invalid",
        "store_stock_limit": {
          "enabled": true,
          "include_trials": true,
          "time_scale": "invalid",
          "quantity": 0,
          "time_value": 0
        },
        "customer_stock_limit": {
          "enabled": true,
          "include_trials": true,
          "time_scale": "invalid",
          "quantity": 0,
          "time_value": 0
        },
        "stock_limit_do_not_include_removed": true,
        "tags": [
          "411486491630370816"
        ],
        "gameservers": [
          "411486491630370816"
        ],
        "commands": [
          {
            "content": "string",
            "online_only": true,
            "stage": "invalid",
            "override_execute_on_gameserver_ids": [
              "411486491630370816"
            ]
          }
        ],
        "deliverable_actions": {
          "grant_giftcard": true
        },
        "metadata": {},
        "payout_splits": [
          {
            "platform_fee": 0,
            "user_id": "411486491630370816",
            "percentage": 0
          }
        ],
        "tax_code": "unknown",
        "allow_concurrent_active_items": true,
        "is_hidden": true,
        "is_gifting_disabled": true,
        "enabled_at": "2024-01-01T00:00:00Z",
        "enabled_until": "2024-01-01T00:00:00Z",
        "required_product_ids": [
          "411486491630370816"
        ],
        "required_product_all": true,
        "custom_variable_ids": [
          "411486491630370816"
        ],
        "is_gift_cards_disabled": true,
        "is_coupons_disabled": true,
        "is_affiliate_links_disabled": true,
        "tier_group_id": "411486491630370816"
      },
      "payout_splits": [
        {
          "payout_id": "string",
          "percentage": 5000,
          "platform_fee": 500
        }
      ],
      "metadata": {}
    }
  ],
  "coupon_id": "411486491630370816",
  "promo_codes": [
    "string"
  ],
  "affiliate_code": "string",
  "return_url": "string",
  "cancel_url": "string",
  "auto_redirect": true,
  "metadata": {},
  "customer_details": {
    "billing_name": "string",
    "billing_email": "string",
    "billing_address": {
      "country": "string",
      "state": "string",
      "city": "string",
      "postal_code": "string",
      "line_1": "string",
      "line_2": "string"
    },
    "billing_tax_id": "string"
  }
}'
Response200
{
  "id": "411486491630370816",
  "token": "string",
  "url": "string"
}