Upsell Settings

Get store upselling settings

GEThttps://api.paynow.gg/v1/stores/{storeId}/upsell-settings

Retrieves upselling settings for the store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

200OKStoreUpsellSettingsDto

Show fields

automatic_recommendations_discount_amountintegerRequired

automatic_recommendations_discount_typeenumRequired

Possible enum values

unknown
none
fixed
percentage

automatic_recommendations_enabledbooleanRequired

checkout_styleenumRequired

Possible enum values

unknown
inline
inline_and_prepayment_dialog
dedicated_step

enabledbooleanRequired

recommendation_overridesStoreUpsellRecommendationDto[]Required

discount_amountintegerRequired

discount_typeenumRequired

Possible enum values

unknown
none
fixed
percentage

prefer_as_subscriptionbooleanRequired

recommended_product_idFlakeIdRequired

typeenumRequired

Possible enum values

unknown
Unknown upsell type.
additional
An additional product offered alongside the current item.
alternative
An alternative product offered in place of the current item.
increase_quantity
An offer to increase the quantity of the current item.

minimum_base_product_quantityintegerOptional

quantity_to_addintegerOptional

recommendation_overrides_enabledbooleanRequired

updated_atstringRequired

updated_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

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

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/upsell-settings" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.upsellSettings.getStoreUpsellSettings();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/upsell-settings", headers=headers)

Response200

{
  "automatic_recommendations_discount_amount": 0,
  "automatic_recommendations_discount_type": "unknown",
  "automatic_recommendations_enabled": true,
  "checkout_style": "unknown",
  "enabled": true,
  "recommendation_overrides": [
    {
      "discount_amount": 0,
      "discount_type": "unknown",
      "prefer_as_subscription": true,
      "recommended_product_id": "411486491630370816",
      "type": "unknown",
      "minimum_base_product_quantity": 0,
      "quantity_to_add": 0
    }
  ],
  "recommendation_overrides_enabled": true,
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Updates store upselling settings

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/upsell-settings

Updates upselling settings for a store.

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

automatic_recommendations_discount_amountintegerOptional

automatic_recommendations_discount_typeenumOptional

Possible enum values

unknown
none
fixed
percentage

automatic_recommendations_enabledbooleanOptional

checkout_styleenumOptional

Possible enum values

unknown
inline
inline_and_prepayment_dialog
dedicated_step

enabledbooleanOptional

recommendation_overridesStoreUpsellRecommendationDto[]Optional

discount_amountintegerRequired

discount_typeenumRequired

Possible enum values

unknown
none
fixed
percentage

prefer_as_subscriptionbooleanRequired

recommended_product_idFlakeIdRequired

typeenumRequired

Possible enum values

unknown
Unknown upsell type.
additional
An additional product offered alongside the current item.
alternative
An alternative product offered in place of the current item.
increase_quantity
An offer to increase the quantity of the current item.

minimum_base_product_quantityintegerOptional

quantity_to_addintegerOptional

recommendation_overrides_enabledbooleanOptional

Response

204No Content

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

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/upsell-settings" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "automatic_recommendations_enabled": true,
  "automatic_recommendations_discount_type": "unknown",
  "automatic_recommendations_discount_amount": 0,
  "recommendation_overrides_enabled": true,
  "recommendation_overrides": [
    {
      "discount_amount": 0,
      "discount_type": "unknown",
      "prefer_as_subscription": true,
      "recommended_product_id": "411486491630370816",
      "type": "unknown",
      "minimum_base_product_quantity": 0,
      "quantity_to_add": 0
    }
  ],
  "checkout_style": "unknown"
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.upsellSettings.updateStoreUpsellSettings({
  enabled: true,
  automatic_recommendations_enabled: true,
  automatic_recommendations_discount_type: "unknown",
  automatic_recommendations_discount_amount: 0,
  recommendation_overrides_enabled: true,
  recommendation_overrides: [
    {
      discount_amount: 0,
      discount_type: "unknown",
      prefer_as_subscription: true,
      recommended_product_id: "411486491630370816",
      type: "unknown",
      minimum_base_product_quantity: 0,
      quantity_to_add: 0,
    },
  ],
  checkout_style: "unknown",
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "enabled": True,
    "automatic_recommendations_enabled": True,
    "automatic_recommendations_discount_type": "unknown",
    "automatic_recommendations_discount_amount": 0,
    "recommendation_overrides_enabled": True,
    "recommendation_overrides": [
        {
            "discount_amount": 0,
            "discount_type": "unknown",
            "prefer_as_subscription": True,
            "recommended_product_id": "411486491630370816",
            "type": "unknown",
            "minimum_base_product_quantity": 0,
            "quantity_to_add": 0,
        },
    ],
    "checkout_style": "unknown",
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/upsell-settings", headers=headers, json=payload)