Skip to content
HALOWERK

Signalwerk

pricing matrix

Takes the plans per provider in the structure returned by pricing-page-extract (tiers with prices: amount, ISO 4217 currency, interval month/year/quarter/week/day/one_time, per_unit, vat, billing). For each plan the recurring price matching the billing preference is chosen; monthly cost = amount × interval factor (year ÷ 12, quarter ÷ 3, week × 52 ÷ 12, day × 365 ÷ 12) × seats when the unit is a user/seat; usage-based units, hourly prices and "price on request" are reported as not comparable.

POST https://signal.halowerk.com/v1/pricing-matrix

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
providersarrayYes
scenarioobjectNo
fx_ratesobjectNoUnits of each currency per 1 EUR (ECB convention), e.g. {"USD": 1.08}. Missing currencies are taken from the ECB.
use_ecbbooleanNoFetch ECB reference rates for currencies missing in fx_rates.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "providers"
  ],
  "properties": {
    "providers": {
      "type": "array",
      "minItems": 2,
      "maxItems": 10,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name",
          "tiers"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "tiers": {
            "type": "array",
            "minItems": 1,
            "maxItems": 20,
            "description": "Plans, e.g. the tiers array of pricing-page-extract.",
            "items": {
              "type": "object",
              "required": [
                "name"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 120
                },
                "price_on_request": {
                  "type": "boolean"
                },
                "free": {
                  "type": "boolean"
                },
                "features": {
                  "type": "array",
                  "maxItems": 100,
                  "items": {
                    "type": "string",
                    "maxLength": 300
                  }
                },
                "prices": {
                  "type": "array",
                  "maxItems": 10,
                  "items": {
                    "type": "object",
                    "required": [
                      "amount",
                      "currency",
                      "interval"
                    ],
                    "properties": {
                      "amount": {
                        "type": "number",
                        "minimum": 0
                      },
                      "currency": {
                        "type": "string",
                        "pattern": "^[A-Z]{3}$"
                      },
                      "interval": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          "month",
                          "year",
                          "quarter",
                          "week",
                          "day",
                          "hour",
                          "one_time",
                          null
                        ]
                      },
                      "per_unit": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "maxLength": 60
                      },
                      "vat": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          "net",
                          "gross",
                          null
                        ]
                      },
                      "billing": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "enum": [
                          "annual",
                          "monthly",
                          null
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "scenario": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "seats": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100000,
          "default": 1,
          "description": "Number of users/seats."
        },
        "billing": {
          "type": "string",
          "enum": [
            "monthly",
            "annual"
          ],
          "default": "monthly",
          "description": "Preferred billing when a plan lists both."
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$",
          "default": "EUR"
        },
        "vat_basis": {
          "type": "string",
          "enum": [
            "as_listed",
            "net"
          ],
          "default": "as_listed"
        },
        "vat_rate_pct": {
          "type": "number",
          "minimum": 0,
          "maximum": 30,
          "description": "VAT rate to convert gross prices to net (e.g. 19)."
        },
        "required_features": {
          "type": "array",
          "maxItems": 20,
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          }
        }
      }
    },
    "fx_rates": {
      "type": "object",
      "maxProperties": 60,
      "additionalProperties": {
        "type": "number",
        "exclusiveMinimum": 0
      },
      "propertyNames": {
        "pattern": "^[A-Z]{3}$"
      },
      "description": "Units of each currency per 1 EUR (ECB convention), e.g. {\"USD\": 1.08}. Missing currencies are taken from the ECB."
    },
    "use_ecb": {
      "type": "boolean",
      "default": true,
      "description": "Fetch ECB reference rates for currencies missing in fx_rates."
    }
  }
}

Open original schema

Published input example

{
  "providers": [
    {
      "name": "A",
      "tiers": [
        {
          "name": "Team",
          "prices": [
            {
              "amount": 29,
              "currency": "EUR",
              "interval": "month",
              "per_unit": "user",
              "vat": "net"
            }
          ]
        }
      ]
    },
    {
      "name": "B",
      "tiers": [
        {
          "name": "Pro",
          "prices": [
            {
              "amount": 199,
              "currency": "EUR",
              "interval": "month"
            }
          ]
        }
      ]
    }
  ],
  "scenario": {
    "seats": 10
  }
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →