Retrieve Financial Products V2 Response Structure

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thisisbud/main/json-schema/thisisbud-get-products-response-v2-schema.json",
  "title": "Retrieve Financial Products V2 Response Structure",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/thisisbud-openapi-openapi.yml#/components/schemas/GetProductsResponseV2",
  "type": "object",
  "required": [
    "operation_id",
    "metadata"
  ],
  "properties": {
    "operation_id": {
      "$ref": "#/$defs/OperationId"
    },
    "data": {
      "type": "array",
      "items": {
        "title": "Financial_Product",
        "description": "A Financial Product that a customer uses.",
        "type": "object",
        "required": [
          "type",
          "merchant",
          "amount",
          "period"
        ],
        "properties": {
          "type": {
            "title": "Financial_Product_Type",
            "description": "A list of the types products and services identified for the given Financial Product. Potential values could be (but not limited to):\n  - `loan`\n  - `bnpl`\n  - `mortgage`\n  - `insurance`\n  - `credit_card`\n  - `private_pension`\n  - `savings_and_investment`\n",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "merchant": {
            "title": "Financial_Product_Merchant",
            "description": "Details of the merchant providing the Financial Product.",
            "type": "object",
            "required": [
              "id",
              "name",
              "logo"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "A unique ID for the merchant."
              },
              "name": {
                "type": "string",
                "description": "The merchant's name in a displayable format."
              },
              "logo": {
                "type": "string",
                "description": "The merchant's logo image URL location."
              }
            }
          },
          "amount": {
            "$ref": "#/$defs/BudAmount"
          },
          "period": {
            "title": "Transaction Period",
            "description": "The period between each transaction for the given product. Possible values are:\n- `daily` -  This product is charged once a day.\n- `weekly` - This product is charged once a week.\n- `biweekly` - This product is charged once every two weeks.\n- `monthly` - This product is charged once a monthy.\n- `quarterly` - This product is charged once a quater (every 3 months).\n- `six_monthly` - product is charged every six months.\n- `annually` - This product is charged once a year.\n- `unknown` - It is unknown how frequently this product is charged.\n",
            "type": "string",
            "enum": [
              "daily",
              "weekly",
              "biweekly",
              "monthly",
              "quarterly",
              "six_monthly",
              "annually",
              "unknown"
            ]
          }
        }
      }
    },
    "metadata": {
      "title": "Metadata",
      "allOf": [
        {
          "$ref": "#/$defs/BudDateRangeMetadata"
        },
        {
          "type": "object",
          "required": [
            "results"
          ],
          "properties": {
            "results": {
              "type": "number",
              "title": "Results count",
              "description": "Number of products returned."
            }
          }
        }
      ]
    }
  },
  "$defs": {
    "BudAmount": {
      "title": "Standard Bud Amount",
      "type": "object",
      "description": "The monetary amount.",
      "required": [
        "value",
        "currency"
      ],
      "properties": {
        "value": {
          "$ref": "#/$defs/BudMonetaryValue"
        },
        "currency": {
          "$ref": "#/$defs/BudCurrency"
        }
      }
    },
    "BudCurrency": {
      "title": "Currency",
      "description": "The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount.\n\nExample: `GBP`\n",
      "type": "string"
    },
    "BudDateRangeMetadata": {
      "title": "Metadata",
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": "string",
          "description": "The date from when results were retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\nThis is either populated with the default value used when retrieving the results, or the user specified parameter.\n\nExamples:\n  - `2023-01-17T17:29:51Z`\n  - `2023-01-17T17:29:51-08:00`\n"
        },
        "to": {
          "type": "string",
          "description": "The date up to when results were retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\nThis is either populated with the default value used when retrieving the results, or the user specified parameter.\n\nExamples:\n  - `2023-03-17T17:29:51Z`\n  - `2023-03-17T17:29:51-08:00`\n"
        }
      }
    },
    "BudMonetaryValue": {
      "title": "Monetary Value",
      "description": "The value of the monetary amount. The value is formatted with the number of decimal places for the respective currency. \n\nExample: `10.98`\n",
      "type": "string"
    },
    "OperationId": {
      "title": "Operation Id Field",
      "type": "string",
      "description": "A unique identifier/reference associated with a given endpoint/operation"
    }
  }
}