HubSpot · JSON Structure

Commerce Payments Api Batch Archive Request Structure

Request body for batch archiving commerce payments

Type: object Properties: 1 Required: 1
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchArchiveRequest is a JSON Structure definition published by HubSpot, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

inputs

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/commerce-payments-api-batch-archive-request-structure.json",
  "name": "BatchArchiveRequest",
  "description": "Request body for batch archiving commerce payments",
  "type": "object",
  "properties": {
    "inputs": {
      "type": "array",
      "description": "List of payment identifiers to archive",
      "items": {
        "type": "object",
        "description": "A single input item for batch read",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the payment to read",
            "example": "500123"
          }
        }
      },
      "example": [
        {
          "id": "500123"
        }
      ]
    }
  },
  "required": [
    "inputs"
  ]
}