HubSpot · Schema

BatchArchiveRequest

Request body for batch archiving commerce payments

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
inputs array List of payment identifiers to archive
View JSON Schema on GitHub

JSON Schema

commerce-payments-api-batch-archive-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/commerce-payments-api-batch-archive-request-schema.json",
  "title": "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"
  ]
}