GET

Get resolved upsell configuration for a merchant and country

https://api.kustom.co/config/checkout/v1/config/country/{country}/upsell

Returns the most-specific active value for the scope. If no active upsell configuration exists for the resolved scope, the endpoint returns 404.

Parameters2 fields

X-merchant-idstringrequiredin header
Merchant identifier
countrystringrequiredin path
ISO 3166-1 alpha-2 country code

200

Response13 fields

merchantIdstringoptional
countrystringoptional
upsellConfigobjectoptional
The configuration for upsell features.
7 fields in upsellConfig
- disabledbooleanoptional
  Indicates whether the upsell feature is disabled. This takes precedence over the alwaysEnable flag.
- alwaysEnablebooleanoptional
  Indicates whether the upsell feature should be enabled even if the upsell configs are missing on orders.
- displayOptionsobjectoptional
  Display options for the upsell feature.
  3 fields in displayOptions
  - uiTimerDisabledbooleanoptional
    Indicates whether the timer should not be shown during upsell.
  - uiTimerDisabledCountries[]array<string>optional
    The countries in which the timer should not be shown during upsell.
  - imageAspectRatiostringoptional
    The aspect ratio of images shown on the upsell page.
- durationSecondsinteger · int32optional
  The duration (in seconds) for which upsell will be available.
revisioninteger · int64optional
updatedBystringoptional
updatedAtstring · date-timeoptional

404

Response13 fields

No active upsell configuration exists for the resolved scope

merchantIdstringoptional
countrystringoptional
upsellConfigobjectoptional
The configuration for upsell features.
7 fields in upsellConfig
- disabledbooleanoptional
  Indicates whether the upsell feature is disabled. This takes precedence over the alwaysEnable flag.
- alwaysEnablebooleanoptional
  Indicates whether the upsell feature should be enabled even if the upsell configs are missing on orders.
- displayOptionsobjectoptional
  Display options for the upsell feature.
  3 fields in displayOptions
  - uiTimerDisabledbooleanoptional
    Indicates whether the timer should not be shown during upsell.
  - uiTimerDisabledCountries[]array<string>optional
    The countries in which the timer should not be shown during upsell.
  - imageAspectRatiostringoptional
    The aspect ratio of images shown on the upsell page.
- durationSecondsinteger · int32optional
  The duration (in seconds) for which upsell will be available.
revisioninteger · int64optional
updatedBystringoptional
updatedAtstring · date-timeoptional

GET https://api.kustom.co/config/checkout/v1/config/country/{country}/upsell

Response 200· OK

{
  "merchantId": "<string>",
  "country": "<string>",
  "upsellConfig": {
    "disabled": false,
    "alwaysEnable": false,
    "displayOptions": {
      "uiTimerDisabled": false,
      "uiTimerDisabledCountries": [
        "US",
        "GB"
      ],
      "imageAspectRatio": "2:3"
    },
    "durationSeconds": 120
  },
  "revision": 0,
  "updatedBy": "<string>",
  "updatedAt": "<date-time>"
}

20 lines

Response 404· No active upsell configuration exists for the resolved scope

{
  "merchantId": "<string>",
  "country": "<string>",
  "upsellConfig": {
    "disabled": false,
    "alwaysEnable": false,
    "displayOptions": {
      "uiTimerDisabled": false,
      "uiTimerDisabledCountries": [
        "US",
        "GB"
      ],
      "imageAspectRatio": "2:3"
    },
    "durationSeconds": 120
  },
  "revision": 0,
  "updatedBy": "<string>",
  "updatedAt": "<date-time>"
}

20 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.