@openactive/data-models/versions/2.x/models/PriceSpecification.json

Data models used to drive that OpenActive validator, developer documentation, and model libraries

{
	"type": "PriceSpecification",
	"derivedFrom": "https://schema.org/PriceSpecification",
	"validationMode": {
		"C1Request": "request",
		"C1Response": "response",
		"C1ResponseOrderItemError": "response",
		"C2Request": "request",
		"C2Response": "response",
		"C2ResponseOrderItemError": "response",
		"PRequest": "request",
		"PResponse": "response",
		"PResponseOrderItemError": "response",
		"BRequest": "request",
		"BResponse": "response",
		"BResponseOrderItemError": "response",
		"OrderProposalPatch": "request",
		"OrderPatch": "request"
	},
	"imperativeConfiguration": {
		"request": {
			"requiredFields": [],
			"recommendedFields": []
		},
		"response": {
			"requiredFields": [
				"type",
				"price"
			]
		}
	},
	"inSpec": [
		"type",
		"price",
		"priceCurrency",
		"openBookingPrepayment"
	],
	"notInSpec": [],
	"fields": {
		"type": {
			"fieldName": "type",
			"requiredType": "https://schema.org/Text",
			"requiredContent": "PriceSpecification"
		},
		"price": {
			"fieldName": "price",
			"requiredType": "https://schema.org/Number",
			"sameAs": "https://schema.org/price",
			"description": [
				"The total amount."
			]
		},
		"priceCurrency": {
			"fieldName": "priceCurrency",
			"requiredType": "https://schema.org/Text",
			"sameAs": "https://schema.org/priceCurrency",
			"description": [
				"The currency of the price. Specified as a 3-letter ISO 4217 value. If a  PriceSpecification has a zero price, then this property is not required. Otherwise the priceCurrency must be specified."
			]
		},
		"openBookingPrepayment": {
			"fieldName": "openBookingPrepayment",
			"sameAs": "https://openactive.io/openBookingPrepayment",
			"requiredType": "https://openactive.io/RequiredStatusType",
			"description": [
				"Indicates if proceeding with booking requires a Customer to pay in advance, pay when attending, or have the option to do either. Values must be one of  https://openactive.io/Required,  https://openactive.io/Optional or  https://openactive.io/Unavailable."
			],
			"example": "https://openactive.io/Required"
		}
	}
}