BigCommerce · Schema

Key Value Pair Schema

Options, ranges, defaults, and validation for a carrier-defined field that displays at checkout.

E-CommerceRetailCatalogOrderCheckoutPaymentsSoftware-as-a-Service

Properties

Name Type Description
code string The internal code that represents this input field.
label string Display name for this input field.
description string Longer description text to be displayed as a tooltip at checkout.
validation string Placeholder for any validation we choose to implement.
type string How this input will be displayed.
default_value string A valid default value for this field.
value_options array The list of options available for `select` type fields.
date_ranges array For date type fields, a set of valid date ranges available to choose from
View JSON Schema on GitHub

JSON Schema

bigcommerce-keyvaluepairschema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyValuePairSchema",
  "title": "Key Value Pair Schema",
  "description": "Options, ranges, defaults, and validation for a carrier-defined field that displays at checkout.",
  "type": "object",
  "properties": {
    "code": {
      "description": "The internal code that represents this input field.",
      "type": "string"
    },
    "label": {
      "description": "Display name for this input field.",
      "type": "string"
    },
    "description": {
      "description": "Longer description text to be displayed as a tooltip at checkout.",
      "type": "string"
    },
    "validation": {
      "description": "Placeholder for any validation we choose to implement.",
      "type": "string"
    },
    "type": {
      "description": "How this input will be displayed.",
      "type": "string",
      "enum": [
        "date",
        "string",
        "select",
        "code"
      ]
    },
    "default_value": {
      "description": "A valid default value for this field.",
      "type": "string"
    },
    "value_options": {
      "description": "The list of options available for `select` type fields.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "date_ranges": {
      "description": "For date type fields, a set of valid date ranges available to choose from",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "from": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string",
                "format": "date"
              },
              "timezone": {
                "type": "string"
              }
            },
            "title": "Date Value",
            "description": "Value Object representing a Date."
          },
          "to": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string",
                "format": "date"
              },
              "timezone": {
                "type": "string"
              }
            },
            "title": "Date Value",
            "description": "Value Object representing a Date."
          }
        },
        "title": "Date Range",
        "description": "Representation of a range of date objects."
      }
    }
  },
  "required": [
    "code",
    "label",
    "type",
    "default_value"
  ],
  "x-internal": false
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/bigcommerce-keyvaluepairschema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.