⬇️ Download profile metadata (JSON-LD) | ⬇️ Download profile metadata (Excel)
This is the full schema.org vocabulary expressed as a MASP schema crate. It is generated automatically from the official schema.org JSON-LD dump using scripts/generate-schema-org-crate.js.
The root class is Thing — every other class in the hierarchy is (directly or transitively) a subclass of Thing.
This schema serves as:
prov:specializationOfTo regenerate this schema from the latest schema.org release:
npm run generate:schema-org-crate
npm run build:schema-org-schema
933 classes · 1521 properties
Represents financial incentives for goods/services offered by an organization (or individual).
Typically contains the [[name]] of the incentive, the [[incentivizedItem]], the [[incentiveAmount]], the [[incentiveStatus]], [[incentiveType]], the [[provider]] of the incentive, and [[eligibleWithSupplier]].
Optionally contains criteria on whether the incentive is limited based on [[purchaseType]], [[purchasePriceLimit]], [[incomeLimit]], and the [[qualifiedExpense]].
breadcrumb may be used. We recommend explicit declaration if these properties are specified, but if they are found outside of an itemscope, they will be assumed to be about the page.21) should only be present on instances of [[IndividualProduct]]10) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.8013) should be attached to a [[Product]] or a [[ProductModel]].[[QuantitativeValue]]: Use this for incentives based on price (either raw amount or percentage-based). For a raw amount example, "You can claim $2,500 - $7,500 from the total cost of installation" would be represented as the following:
{ "@type": "QuantitativeValue", “minValue”: 2500, “maxValue”: 7500, "unitCode": "USD" }[[QuantitativeValue]] can also be used for percentage amounts. In such cases, value is used to represent the incentive’s percentage, while maxValue represents a limit (if one exists) to that incentive. The unitCode should be 'P1' and the unitText should be '%', while valueReference should be used for holding the currency type. For example, "You can claim up to 30% of the total cost of installation, up to a maximum of $7,500" would be:
{ "@type": "QuantitativeValue", "value": 30, "unitCode": "P1", "unitText": "%", “maxValue”: 7500, “valueReference”: “USD” }[[UnitPriceSpecification]]: Use this for incentives that are based on amounts rather than price. For example, a net metering rebate that pays $10/kWh, up to $1,000:
{ "@type": "UnitPriceSpecification", "price": 10, "priceCurrency": "USD", "referenceQuantity": 1, "unitCode": "DO3", "unitText": "kw/h", "maxPrice": 1000, "description": "$10 / kwh up to $1000" }[[LoanOrCredit]]: Use for incentives that are loan based. For example, a loan of $4,000 - $50,000 with a repayment term of 10 years, interest free would look like:
{ "@type": "LoanOrCredit", "loanTerm": { "@type":"QuantitativeValue", "value":"10", "unitCode": "ANN" }, "amount":[ { "@type": "QuantitativeValue", "Name":"fixed interest rate", "value":"0", }, ], "amount":[ { "@type": "MonetaryAmount", "Name":"min loan amount", "value":"4000", "currency":"CAD" }, { "@type": "MonetaryAmount", "Name":"max loan amount", "value":"50000", "currency":"CAD" } ], } In summary:DefinedTermSets are used for product and service categories such as the United Nations Standard Products and Services Code:
{ "@type": "DefinedTerm", "inDefinedTermSet": "https://www.unspsc.org/", "termCode": "261315XX", "name": "Photovoltaic module" }For a specific product or service, use the Product type:
{ "@type": "Product", "name": "Kenmore White 17" Microwave", } For multiple different incentivized items, use multiple [[DefinedTerm]] or [[Product]].If MonetaryAmount is specified, this should be based on annualized income (e.g. if an incentive is limited to those making <$114,000 annually):
{ "@type": "MonetaryAmount", "maxValue": 114000, "currency": "USD", } Use Text for incentives that are limited based on other criteria, for example if an incentive is only available to recipients making 120% of the median poverty income in their area.<time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time>.\n* If a business is open 7 days a week, then it can be specified as <time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time>.