Products | PayNow API

Get products

get

Retrieves all products for the specified store. DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve products for.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/products HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "version_id": "411486491630370816",
    "image_url": "text",
    "slug": "text",
    "name": "text",
    "description": "text",
    "label": "text",
    "sort_order": 1,
    "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",
    "stock_available": {
      "store_available": 1,
      "customer_available": 1
    },
    "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": [
      {
        "id": "411486491630370816",
        "slug": "packages",
        "name": "Packages"
      }
    ],
    "gameservers": [
      {
        "id": "411486491630370816",
        "name": "US 2x TRIO",
        "enabled": true
      }
    ],
    "commands": [
      {
        "stage": "invalid",
        "content": "text",
        "online_only": true,
        "override_execute_on_gameserver_ids": [
          "411486491630370816"
        ]
      }
    ],
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "created_at": "2025-08-22T17:43:57.521Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": "2025-08-22T17:43:57.521Z",
    "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-22T17:43:57.521Z",
    "enabled_until": "2025-08-22T17:43:57.521Z",
    "required_product_ids": [
      "411486491630370816"
    ],
    "required_product_all": true,
    "custom_variable_ids": [
      "411486491630370816"
    ]
  }
]

Create product

post

Creates a new product in the specified store. Creating dynamic products while creating a checkout session via this endpoint without prior approval is prohibited and will result in store deactivation per our User Agreement.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to create the product in.

Example: 411486491630370816

Body

slugstring | nullableOptional

The unique URL-safe identifier (slug) for the product.

namestring | nullableOptional

The display name of the product.

descriptionstring | nullableOptional

The detailed description of the product.

labelstring | nullableOptional

The display label for the product.

priceinteger · int64 | nullableOptional

The price of the product in the lowest denominator (e.g. cents).

single_game_server_onlyboolean | nullableOptional

Indicates whether the customer is prompted to select a game server before purchasing.

allow_one_time_purchaseboolean | nullableOptional

Indicates whether one-time purchases are allowed.

allow_subscriptionboolean | nullableOptional

Indicates whether subscription purchases are allowed.

subscription_interval_valueinteger · int32 | nullableOptional

The subscription interval value.

subscription_interval_scalestring · enumOptionalPossible values:

remove_after_enabledboolean | nullableOptional

Indicates whether automatic removal is enabled.

remove_after_time_valueinteger · int32 | nullableOptional

The time value for automatic removal.

remove_after_time_scalestring · enumOptionalPossible values:

stock_limit_do_not_include_removedboolean | nullableOptional

Indicates whether removed items should be excluded from stock limits.

tagsstring · flake-id[] | nullableOptional

The tag IDs associated with the product.

Example: 411486491630370816

gameserversstring · flake-id[] | nullableOptional

The gameserver IDs associated with the product.

Example: 411486491630370816

tax_codestring · enumOptional

Determines the category of the product for taxation purposes. Contact support for help with setting the correct tax code.

Possible values:

allow_concurrent_active_itemsboolean | nullableOptional

Indicates whether concurrent active items are allowed.

disable_promo_codesboolean | nullableOptional

Indicates whether using coupons and gift cards on this product is allowed.

is_hiddenboolean | nullableOptional

Indicates whether the product is hidden.

is_gifting_disabledboolean | nullableOptional

Indicates whether gifting is disabled.

enabled_atstring · date-time | nullableOptional

The date and time when the product becomes enabled. Set to null to keep enabled.

enabled_untilstring · date-time | nullableOptional

The date and time until which the product remains enabled. Set to null to keep enabled.

required_product_idsstring · flake-id[] | nullableOptional

The IDs of products required for purchasing this product.

Example: 411486491630370816

required_product_allboolean | nullableOptional

Indicates whether all required products are needed.

custom_variable_idsstring · flake-id[] | nullableOptional

The IDs of associated custom variables.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

post

POST /v1/stores/{storeId}/products HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250

{
  "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-22T17:43:57.521Z",
  "enabled_until": "2025-08-22T17:43:57.521Z",
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_product_all": true,
  "custom_variable_ids": [
    "411486491630370816"
  ]
}

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "version_id": "411486491630370816",
  "image_url": "text",
  "slug": "text",
  "name": "text",
  "description": "text",
  "label": "text",
  "sort_order": 1,
  "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",
  "stock_available": {
    "store_available": 1,
    "customer_available": 1
  },
  "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": [
    {
      "id": "411486491630370816",
      "slug": "packages",
      "name": "Packages"
    }
  ],
  "gameservers": [
    {
      "id": "411486491630370816",
      "name": "US 2x TRIO",
      "enabled": true
    }
  ],
  "commands": [
    {
      "stage": "invalid",
      "content": "text",
      "online_only": true,
      "override_execute_on_gameserver_ids": [
        "411486491630370816"
      ]
    }
  ],
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-22T17:43:57.521Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-22T17:43:57.521Z",
  "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-22T17:43:57.521Z",
  "enabled_until": "2025-08-22T17:43:57.521Z",
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_product_all": true,
  "custom_variable_ids": [
    "411486491630370816"
  ]
}

Get product

get

Retrieves a specific product by ID from the specified store. DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store the product belongs to.

Example: 411486491630370816

productIdstring · flake-idRequired

The ID of the product to retrieve.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/products/{productId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "version_id": "411486491630370816",
  "image_url": "text",
  "slug": "text",
  "name": "text",
  "description": "text",
  "label": "text",
  "sort_order": 1,
  "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",
  "stock_available": {
    "store_available": 1,
    "customer_available": 1
  },
  "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": [
    {
      "id": "411486491630370816",
      "slug": "packages",
      "name": "Packages"
    }
  ],
  "gameservers": [
    {
      "id": "411486491630370816",
      "name": "US 2x TRIO",
      "enabled": true
    }
  ],
  "commands": [
    {
      "stage": "invalid",
      "content": "text",
      "online_only": true,
      "override_execute_on_gameserver_ids": [
        "411486491630370816"
      ]
    }
  ],
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-22T17:43:57.521Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-22T17:43:57.521Z",
  "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-22T17:43:57.521Z",
  "enabled_until": "2025-08-22T17:43:57.521Z",
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_product_all": true,
  "custom_variable_ids": [
    "411486491630370816"
  ]
}

Delete product

delete

Deletes a product from the specified store.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store the product belongs to.

Example: 411486491630370816

productIdstring · flake-idRequired

The ID of the product to delete.

Example: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

DELETE /v1/stores/{storeId}/products/{productId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update product

patch

Updates an existing product in the specified store.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store the product belongs to.

Example: 411486491630370816

productIdstring · flake-idRequired

The ID of the product to update.

Example: 411486491630370816

Body

slugstring | nullableOptional

The unique URL-safe identifier (slug) for the product.

namestring | nullableOptional

The display name of the product.

descriptionstring | nullableOptional

The detailed description of the product.

labelstring | nullableOptional

The display label for the product.

priceinteger · int64 | nullableOptional

The price of the product in the lowest denominator (e.g. cents).

single_game_server_onlyboolean | nullableOptional

Indicates whether the customer is prompted to select a game server before purchasing.

allow_one_time_purchaseboolean | nullableOptional

Indicates whether one-time purchases are allowed.

allow_subscriptionboolean | nullableOptional

Indicates whether subscription purchases are allowed.

subscription_interval_valueinteger · int32 | nullableOptional

The subscription interval value.

subscription_interval_scalestring · enumOptionalPossible values:

remove_after_enabledboolean | nullableOptional

Indicates whether automatic removal is enabled.

remove_after_time_valueinteger · int32 | nullableOptional

The time value for automatic removal.

remove_after_time_scalestring · enumOptionalPossible values:

stock_limit_do_not_include_removedboolean | nullableOptional

Indicates whether removed items should be excluded from stock limits.

tagsstring · flake-id[] | nullableOptional

The tag IDs associated with the product.

Example: 411486491630370816

gameserversstring · flake-id[] | nullableOptional

The gameserver IDs associated with the product.

Example: 411486491630370816

tax_codestring · enumOptional

Determines the category of the product for taxation purposes. Contact support for help with setting the correct tax code.

Possible values:

allow_concurrent_active_itemsboolean | nullableOptional

Indicates whether concurrent active items are allowed.

disable_promo_codesboolean | nullableOptional

Indicates whether using coupons and gift cards on this product is allowed.

is_hiddenboolean | nullableOptional

Indicates whether the product is hidden.

is_gifting_disabledboolean | nullableOptional

Indicates whether gifting is disabled.

enabled_atstring · date-time | nullableOptional

The date and time when the product becomes enabled. Set to null to keep enabled.

enabled_untilstring · date-time | nullableOptional

The date and time until which the product remains enabled. Set to null to keep enabled.

required_product_idsstring · flake-id[] | nullableOptional

The IDs of products required for purchasing this product.

Example: 411486491630370816

required_product_allboolean | nullableOptional

Indicates whether all required products are needed.

custom_variable_idsstring · flake-id[] | nullableOptional

The IDs of associated custom variables.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

patch

PATCH /v1/stores/{storeId}/products/{productId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250

{
  "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-22T17:43:57.521Z",
  "enabled_until": "2025-08-22T17:43:57.521Z",
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_product_all": true,
  "custom_variable_ids": [
    "411486491630370816"
  ]
}

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "version_id": "411486491630370816",
  "image_url": "text",
  "slug": "text",
  "name": "text",
  "description": "text",
  "label": "text",
  "sort_order": 1,
  "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",
  "stock_available": {
    "store_available": 1,
    "customer_available": 1
  },
  "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": [
    {
      "id": "411486491630370816",
      "slug": "packages",
      "name": "Packages"
    }
  ],
  "gameservers": [
    {
      "id": "411486491630370816",
      "name": "US 2x TRIO",
      "enabled": true
    }
  ],
  "commands": [
    {
      "stage": "invalid",
      "content": "text",
      "online_only": true,
      "override_execute_on_gameserver_ids": [
        "411486491630370816"
      ]
    }
  ],
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-22T17:43:57.521Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-22T17:43:57.521Z",
  "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-22T17:43:57.521Z",
  "enabled_until": "2025-08-22T17:43:57.521Z",
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_product_all": true,
  "custom_variable_ids": [
    "411486491630370816"
  ]
}

Update product sort order

post

Updates the sort order of products in the specified store.

Authorizations

Path parameters

storeIdstring · flake-idRequired

The ID of the store to update product sort order in.

Example: 411486491630370816

Body

product_idsstring · flake-id[]Required

An array of product IDs in the order that they should be sorted.

Example: 411486491630370816

Responses

204

No Content

application/json

default

Error response

application/json

post

POST /v1/stores/{storeId}/products/sort-order HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "product_ids": [
    "411486491630370816"
  ]
}

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "version_id": "411486491630370816",
  "image_url": "text",
  "slug": "text",
  "name": "text",
  "description": "text",
  "label": "text",
  "sort_order": 1,
  "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",
  "stock_available": {
    "store_available": 1,
    "customer_available": 1
  },
  "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": [
    {
      "id": "411486491630370816",
      "slug": "packages",
      "name": "Packages"
    }
  ],
  "gameservers": [
    {
      "id": "411486491630370816",
      "name": "US 2x TRIO",
      "enabled": true
    }
  ],
  "commands": [
    {
      "stage": "invalid",
      "content": "text",
      "online_only": true,
      "override_execute_on_gameserver_ids": [
        "411486491630370816"
      ]
    }
  ],
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "created_at": "2025-08-22T17:43:57.521Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": "2025-08-22T17:43:57.521Z",
  "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-22T17:43:57.521Z",
  "enabled_until": "2025-08-22T17:43:57.521Z",
  "required_product_ids": [
    "411486491630370816"
  ],
  "required_product_all": true,
  "custom_variable_ids": [
    "411486491630370816"
  ]
}