WooCommerce · Schema

StoreProductPrice

Formatted price information for a product or variation.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name	Type	Description
price	string	Current price as a formatted string with currency symbol.
regular_price	string	Regular price as a formatted string.
sale_price	string	Sale price as a formatted string (empty when not on sale).
price_range	object	Price range for variable products.
currency_code	string	ISO 4217 currency code.
currency_symbol	string	Currency symbol.
currency_decimal_separator	string	Decimal separator character.
currency_thousand_separator	string	Thousands separator character.
currency_prefix	string	Currency prefix (e.g. $).
currency_suffix	string	Currency suffix.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-store-api-store-product-price-schema.json",
  "title": "StoreProductPrice",
  "description": "Formatted price information for a product or variation.",
  "type": "object",
  "properties": {
    "price": {
      "type": "string",
      "description": "Current price as a formatted string with currency symbol.",
      "example": "string-value"
    },
    "regular_price": {
      "type": "string",
      "description": "Regular price as a formatted string.",
      "example": "string-value"
    },
    "sale_price": {
      "type": "string",
      "description": "Sale price as a formatted string (empty when not on sale).",
      "example": "string-value"
    },
    "price_range": {
      "type": "object",
      "description": "Price range for variable products.",
      "nullable": true,
      "properties": {
        "min_amount": {
          "type": "string",
          "description": "Minimum variation price."
        },
        "max_amount": {
          "type": "string",
          "description": "Maximum variation price."
        }
      },
      "example": {
        "min_amount": "string-value",
        "max_amount": "string-value"
      }
    },
    "currency_code": {
      "type": "string",
      "description": "ISO 4217 currency code.",
      "example": "string-value"
    },
    "currency_symbol": {
      "type": "string",
      "description": "Currency symbol.",
      "example": "string-value"
    },
    "currency_decimal_separator": {
      "type": "string",
      "description": "Decimal separator character.",
      "example": "string-value"
    },
    "currency_thousand_separator": {
      "type": "string",
      "description": "Thousands separator character.",
      "example": "string-value"
    },
    "currency_prefix": {
      "type": "string",
      "description": "Currency prefix (e.g. $).",
      "example": "string-value"
    },
    "currency_suffix": {
      "type": "string",
      "description": "Currency suffix.",
      "example": "string-value"
    }
  }
}