HubSpot · Schema

BatchResponseSubscription

BatchResponseSubscription schema from HubSpot Commerce Subscriptions API

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string
results array
completedAt string
View JSON Schema on GitHub

JSON Schema

commerce-subscriptions-api-batch-response-subscription-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-subscriptions-api-batch-response-subscription-schema.json",
  "title": "BatchResponseSubscription",
  "description": "BatchResponseSubscription schema from HubSpot Commerce Subscriptions API",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "active"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A HubSpot commerce subscription record.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the subscription.",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The subscription's properties as key-value pairs.",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "archived": {
            "type": "boolean",
            "example": true
          },
          "associations": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/CollectionResponseAssociation"
            },
            "example": {
              "key": "value"
            }
          }
        }
      },
      "example": [
        {
          "id": "500123",
          "properties": {
            "key": "value"
          },
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "archived": true,
          "associations": {
            "key": "value"
          }
        }
      ]
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}