HubSpot · JSON Structure

Hubspot Commerce Payments Batch Read Request Structure

Request body for batch reading commerce payments

Type: object Properties: 4 Required: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchReadRequest is a JSON Structure definition published by HubSpot, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

inputs properties propertiesWithHistory idProperty

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Request body for batch reading commerce payments",
  "name": "BatchReadRequest",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "List of payment identifiers to read",
      "items": {
        "type": "object",
        "description": "A single input item for batch read",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the payment to read"
          }
        },
        "required": [
          "id"
        ]
      }
    },
    "properties": {
      "type": "array",
      "description": "Properties to return for each payment",
      "items": {
        "type": "string"
      }
    },
    "propertiesWithHistory": {
      "type": "array",
      "description": "Properties to return with history",
      "items": {
        "type": "string"
      }
    },
    "idProperty": {
      "type": "string",
      "description": "The property to use as the identifier"
    }
  },
  "required": [
    "inputs",
    "properties"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}