SumUp · Schema

Product

Purchase product.

PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Properties

Name	Type	Description
name	string	Product name.
price_label	string	Product description.
price	number	Product price.
vat_rate	number	VAT percentage.
single_vat_amount	number	VAT amount for a single product.
price_with_vat	number	Product price incl. VAT.
vat_amount	number	VAT amount.
quantity	integer	Product quantity.
total_price	number	Quantity x product price.
total_with_vat	number	Total price incl. VAT.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Product",
  "description": "Purchase product.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Product name.",
      "type": "string",
      "example": "Purchase reader for merchant with code ME3FCAVF"
    },
    "price_label": {
      "description": "Product description.",
      "type": "string"
    },
    "price": {
      "description": "Product price.",
      "type": "number",
      "format": "decimal",
      "example": 100
    },
    "vat_rate": {
      "description": "VAT percentage.",
      "type": "number",
      "format": "decimal"
    },
    "single_vat_amount": {
      "description": "VAT amount for a single product.",
      "type": "number",
      "format": "decimal"
    },
    "price_with_vat": {
      "description": "Product price incl. VAT.",
      "type": "number",
      "format": "decimal"
    },
    "vat_amount": {
      "description": "VAT amount.",
      "type": "number",
      "format": "decimal"
    },
    "quantity": {
      "description": "Product quantity.",
      "type": "integer",
      "example": 1
    },
    "total_price": {
      "description": "Quantity x product price.",
      "type": "number",
      "format": "decimal",
      "example": 100
    },
    "total_with_vat": {
      "description": "Total price incl. VAT.",
      "type": "number",
      "format": "decimal"
    }
  }
}