HubSpot · JSON Structure

Commerce Payments Api Commerce Payment Input Structure

Input for creating a new commerce payment

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

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

Properties

properties associations

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-commerce-payment-input-structure.json",
  "name": "CommercePaymentInput",
  "description": "Input for creating a new commerce payment",
  "type": "object",
  "properties": {
    "properties": {
      "type": "object",
      "description": "The properties to set on the commerce payment",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    },
    "associations": {
      "type": "array",
      "description": "Associations to create with other objects",
      "items": {
        "type": "object",
        "description": "Input for creating an association",
        "required": [
          "to",
          "types"
        ],
        "properties": {
          "to": {
            "type": "object",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the object to associate with"
              }
            },
            "example": {
              "id": "500123"
            }
          },
          "types": {
            "type": "array",
            "description": "The association types",
            "items": {
              "$ref": "#/components/schemas/AssociationType"
            },
            "example": [
              {
                "associationCategory": "HUBSPOT_DEFINED",
                "associationTypeId": 500123
              }
            ]
          }
        }
      },
      "example": [
        {
          "to": {
            "id": {}
          },
          "types": [
            {}
          ]
        }
      ]
    }
  },
  "required": [
    "properties"
  ]
}