Thing > Intangible > StructuredValue > PriceSpecification

A structured value representing a monetary amount. Typically, only the subclasses of this type are used for markup.

Usage: Between 10,000 and 50,000 domains
[more...]
PropertyExpected TypeDescription
Properties from PriceSpecification
eligibleQuantity QuantitativeValue The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.
eligibleTransactionVolume PriceSpecification The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
maxPrice Number The highest price if the price is a range.
minPrice Number The lowest price if the price is a range.
price Number  or
Text 
The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.

Usage guidelines:
  • Use the priceCurrency property (with ISO 4217 codes e.g. "USD") instead of including ambiguous symbols such as '$' in the value.
  • Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
  • Note that both RDFa and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.
  • Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
priceCurrency Text The currency (in 3-letter ISO 4217 format) of the price or a price component, when attached to PriceSpecification and its subtypes.
validFrom DateTime The date when the item becomes valid.
validThrough DateTime The end of the validity of offer, price specification, or opening hours data.
valueAddedTaxIncluded Boolean Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A short description of the item.
image URL  or
ImageObject 
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

Many (but not all) pages have a fairly clear primary topic, some entity or thing that the page describes. For example a restaurant's home page might be primarily about that Restaurant, or an event listing page might represent a single event. The mainEntity and mainEntityOfPage properties allow you to explicitly express the relationship between the page and the primary entity.

Related properties include sameAs, about, and url.

The sameAs and url properties are both similar to mainEntityOfPage. The url property should be reserved to refer to more official or authoritative web pages, such as the item’s official website. The sameAs property also relates a thing to a page that indirectly identifies it. Whereas sameAs emphasises well known pages, the mainEntityOfPage property serves more to clarify which of several entities is the main one for that page.

mainEntityOfPage can be used for any page, including those not recognized as authoritative for that entity. For example, for a product, sameAs might refer to a page on the manufacturer’s official site with specs for the product, while mainEntityOfPage might be used on pages within various retailers’ sites giving details for the same product.

about is similar to mainEntity, with two key differences. First, about can refer to multiple entities/topics, while mainEntity should be used for only the primary one. Second, some pages have a primary entity that itself describes some other entity. For example, one web page may display a news article about a particular person. Another page may display a product review for a particular product. In these cases, mainEntity for the pages should refer to the news article or review, respectively, while about would more properly refer to the person or product.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.


Instances of PriceSpecification may appear as values for the following properties
PropertyOn TypesDescription
baseSalary JobPosting  or
EmployeeRole 
The base salary of the job or of an employee in an EmployeeRole.
eligibleTransactionVolume Demand  or
PriceSpecification  or
Offer 
The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
minimumPaymentDue Invoice The minimum payment required at this time.
netWorth Person The total financial value of the organization or person as calculated by subtracting assets from liabilities.
priceSpecification Demand  or
TradeAction  or
Offer 
One or more detailed price specifications, indicating the unit price and delivery or payment charges.
totalPaymentDue Invoice The total amount due.
totalPrice Reservation  or
Ticket 
The total price for the reservation or ticket, including applicable taxes, shipping, etc.

More specific Types
  • DeliveryChargeSpecification
  • PaymentChargeSpecification
  • UnitPriceSpecification

    Acknowledgements

    This class is derived from the GoodRelations Vocabulary for E-Commerce, created by Martin Hepp. GoodRelations is a data model for sharing e-commerce data on the Web that can be expressed in a variety of syntaxes, including RDFa and HTML5 Microdata. More information about GoodRelations can be found at http://purl.org/goodrelations/.


    Examples

    An example of a credit card bill (invoice).
    ACME Bank
    Bill for: January 2015 Visa
    invoice link: http://www.acmebank.com/invoice.pdf
    Customer: Jane Doe
    account ID: xxxx-xxxx-xxxx-1234
    payment due: 2015-01-30
    minimum payment: $15.00
    total due: $200.00
    billing period: 2014-12-21 to 2015-01-20
    payment due
    
    <div itemscope itemtype="http://schema.org/Invoice">
      <h1 itemprop="description">January 2015 Visa</h1>
      <link itemprop="url" href="http://acmebank.com/invoice.pdf" />Invoice PDF
      <div itemprop="broker" itemscope itemtype="http://schema.org/BankOrCreditUnion">
        <b itemprop="name">ACME Bank</b>
      </div>
      <span itemprop="accountId">xxxx-xxxx-xxxx-1234</span>
      <div itemprop="customer" itemscope itemtype="http://schema.org/Person">
        <b itemprop="name">Jane Doe</b>
      </div>
      <span itemprop="paymentDue">2015-01-30</span>
      <div itemprop="minimumPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">15.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <div itemprop="totalPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">200.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <meta itemprop="billingPeriod" content="2014-12-21/P30D" />starts:2014-12-21 30 days
      <span itemprop="paymentStatus">payment due</span>
    </div>
     
    
    <div vocab="http://schema.org/" typeof="Invoice">
      <h1 property="description">January 2015 Visa</h1>
      <link property="url" href="http://acmebank.com/invoice.pdf" />Invoice PDF
      <div property="broker" itemscope typeof="http://schema.org/BankOrCreditUnion">
        <b property="name">ACME Bank</b>
      </div>
      <span property="accountId">xxxx-xxxx-xxxx-1234</span>
      <div property="customer" typeof="http://schema.org/Person">
        <b property="name">Jane Doe</b>
      </div>
      <span property="paymentDue">2015-01-30</span>
      <div property="minimumPaymentDue" typeof="http://schema.org/PriceSpecification">
        <span property="price">15.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <div property="totalPaymentDue" typeof="http://schema.org/PriceSpecification">
        <span property="price">200.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <meta property="billingPeriod" content="2014-12-21/P30D" />starts:2014-12-21 30 days
      <span property="paymentStatus">payment due</span>
    </div>
    
    <script type="application/ld+json">
    {
        "@context": "http://schema.org/",
        "@type": "Invoice",
        "description": "January 2015 Visa bill.",
        "url": "http://acmebank.com/invoice.pdf",
        "broker": {
          "@type": "BankOrCreditUnion",
          "name": "ACME Bank",
        },
        "accountId": "xxxx-xxxx-xxxx-1234",
        "customer": {
          "@type": "Person",
          "name": "Jane Doe"
        },
        "paymentDue": "2015-01-30",
        "minimumPaymentDue": {
          "@type": "PriceSpecification",
          "price": 15.00,
          "priceCurrency": "USD"
        },
        "totalPaymentDue": {
          "@type": "PriceSpecification",
          "price": 200.00,
          "priceCurrency": "USD"
        },
        "billingPeriod": "2014-12-21/P30D",
        "paymentStatus": "payment due"
    }
    </script>
    
    An example of a invoice for a purchase and installation.
    ACME Home Heating
    Bill for: New furnace and installation
    Customer: Jane Doe
    payment due: 2015-01-30
    minimum payment: $0.00
    total due: $0.00
    payment status: paid
    order: furnace model ABC123
    order: installation labor
    
    <div itemscope itemtype="http://schema.org/Invoice">
      <h1 itemprop="description">New furnace and installation</h1>
      <div itemprop="broker" itemscope itemtype="http://schema.org/LocalBusiness">
        <b itemprop="name">ACME Home Heating</b>
      </div>
      <div itemprop="customer" itemscope itemtype="http://schema.org/Person">
        <b itemprop="name">Jane Doe</b>
      </div>
      <span itemprop="paymentDue">2015-01-30</span>
      <div itemprop="minimumPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">0.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <div itemprop="totalPaymentDue" itemscope itemtype="http://schema.org/PriceSpecification">
        <span itemprop="price">0.00</span>
        <span itemprop="priceCurrency">USD</span>
      </div>
      <span itemprop="paymentStatus">paid</span>
      <div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order">
        <span itemprop="description">furnace</span>
        <span itemprop="orderDate">2014-12-01</span>
        <span itemprop="orderNumber">123ABC</span>
        <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Product">
          <span itemprop="name">ACME Furnace 3000</span>
          <meta itemprop="productId" content="ABC123" />
        </div>
      </div>
      <div itemprop="referencesOrder" itemscope itemtype="http://schema.org/Order">
        <span itemprop="description">furnace installation</span>
        <span itemprop="orderDate">2014-12-02</span>
        <div itemprop="orderedItem" itemscope itemtype="http://schema.org/Service">
          <span itemprop="description">furnace installation</span>
        </div>
      </div>
    </div>
     
    
    <div vocab="http://schema.org/" typeof="Invoice">
      <h1 property="description">New furnace and installation</h1>
      <div property="broker" itemscope typeof="http://schema.org/LocalBusiness">
        <b property="name">ACME Home Heating</b>
      </div>
      <div property="customer" typeof="http://schema.org/Person">
        <b property="name">Jane Doe</b>
      </div>
      <span property="paymentDue">2015-01-30</span>
      <div property="minimumPaymentDue" typeof="http://schema.org/PriceSpecification">
        <span property="price">0.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <div property="totalPaymentDue" typeof="http://schema.org/PriceSpecification">
        <span property="price">0.00</span>
        <span property="priceCurrency">USD</span>
      </div>
      <meta property="billingPeriod" content="2014-12-21/P30D" />starts:2014-12-21 30 days
      <span property="paymentStatus">paid</span>
      <div property="referencesOrder" typeof="Order">
        <span property="description">furnace</span>
        <span property="orderDate">2014-12-01</span>
        <span property="orderNumber">123ABC</span>
        <div property="orderedItem" typeof="Product">
          <span property="name">ACME Furnace 3000</span>
          <meta property="productId" content="ABC123" />
        </div>
      </div>
      <div property="referencesOrder" typeof="Order">
        <span property="description">furnace installation</span>
        <span property="orderDate">2014-12-02</span>
        <div property="orderedItem" typeof="Service">
          <span property="description">furnace installation</span>
        </div>
      </div>
    </div>
    
    <script type="application/ld+json">
    {
        "@context": "http://schema.org/",
        "@type": "Invoice",
        "broker": {
          "@type": "LocalBusiness",
          "name": "ACME Home Heating",
        },
        "accountId": "xxxx-xxxx-xxxx-1234",
        "customer": {
          "@type": "Person",
          "name": "Jane Doe"
        },
        "paymentDue": "2015-01-30",
        "minimumPaymentDue": {
          "@type": "PriceSpecification",
          "price": 0.00,
          "priceCurrency": "USD"
        },
        "totalPaymentDue": {
          "@type": "PriceSpecification",
          "price": 0.00,
          "priceCurrency": "USD"
        },
        "paymentStatus": "paid",
        "referencesOrder": [
          {
            "@type": "Order",
            "description": "furnace",
            "orderDate": "2014-12-01",
            "orderNumber": "123ABC",
            "paymentMethod": "http://purl.org/goodrelations/v1#ByInvoice",
            "orderedItem": {
              "@type": "Product",
              "name": "ACME Furnace 3000",
              "productId": "ABC123"
            }
          },
          {
            "@type": "Order",
            "description": "furnace installation",
            "orderDate": "2014-12-02",
            "paymentMethod": "http://purl.org/goodrelations/v1#ByInvoice",
            "orderedItem": {
              "@type": "Service",
              "description": "furnace installation"
            }
          },
        ]
    }
    </script>
    

    Schema Version 2.0