HubSpot: Commerce payments schemas

← Commerce payments operations · All schemas

Batch archive objects — commerce Payments batch Delete Commerce Payments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing a unique identifier for a CRM object. This is used to specify which objects are involved in the batch operation.
inputs[]	Model	Each item	Expand Batch archive price book items — request body — body inputs item

Referenced models: Batch archive price book items — request body — body inputs item

Batch create objects — commerce Payments batch Create Commerce Payments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of objects to be created, each conforming to the SimplePublicObjectBatchInputForCreate schema.
inputs[]	Model	Each item	Expand Batch create objects — commerce Payments batch Create Commerce Payments — request body — body inputs item

Referenced models: Batch create objects — commerce Payments batch Create Commerce Payments — request body — body inputs item

Batch create objects — commerce Payments batch Create Commerce Payments — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations for the CRM objects. Each association is defined by a 'PublicAssociationsForObject' object, which specifies the target object and the types of associations.
associations[]	Model	Each item	Expand Create — commerce Payments create Commerce Payment — request body — body associations item
objectWriteTraceId	string	Optional	A string identifier used to trace the write operation for the objects being created.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM objects. Each property value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — commerce Payments create Commerce Payment — request body — body associations item

Batch upsert objects — commerce Payments batch Upsert Commerce Payments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert objects, each containing the data necessary to upsert a single object. This includes properties and optional identifiers.
inputs[]	Model	Each item	Expand Batch upsert objects — commerce Payments batch Upsert Commerce Payments — request body — body inputs item

Referenced models: Batch upsert objects — commerce Payments batch Upsert Commerce Payments — request body — body inputs item

Batch upsert objects — commerce Payments batch Upsert Commerce Payments — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	The unique identifier for the object, represented as a string.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	An optional string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	A map of property names to their values for the object. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
new	boolean	Required within parent	A boolean indicating whether this object was newly created during the upsert operation.
objectWriteTraceId	string	Optional	An identifier used to trace the write operation for this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — commerce Payments merge — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL of the object in HubSpot.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Merge objects — commerce Payments merge — response body — properties With History value item

Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Payments Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs that provide additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Payments Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each represented as a StandardError.
errors[]	Model	Each item	Expand Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs containing documentation or additional resources related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Batch upsert objects — commercePayments.batchUpsertCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Create — commerce Payments create Commerce Payment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associations	array	Required within parent	An array of associations that link this object to other objects. Each association is defined by the 'PublicAssociationsForObject' schema.
associations[]	Model	Each item	Expand Create — commerce Payments create Commerce Payment — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM object. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — commerce Payments create Commerce Payment — request body — body associations item

Create — commerce Payments create Commerce Payment — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Create — tasks create Task — request body — body associations item to
types	array	Required within parent	An array of association specifications, each detailing the type of association between the objects. Each item in the array is an AssociationSpec object, which defines the category and type ID of the association.
types[]	Model	Each item	Expand Create a contact — request body — body associations item types item

Referenced models: Create a contact — request body — body associations item types item, Create — tasks create Task — request body — body associations item to

GDPR Delete — commerce Payments gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectId	string	Required within parent	The unique identifier for the object to be deleted. This is a required field and must be a string.

List Associations — commerce Payments get Associations By To Object Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
paging	Model	Optional	Expand List — commerce Payments get Commerce Payments — response body — paging
results	array	Required within parent	An array of objects, each representing an association with labels to another object. Each item includes details about the associated object and the types of associations.
results[]	Model	Each item	Expand List Associations — commerce Payments get Associations By To Object Type — response body — results item

Referenced models: List — commerce Payments get Commerce Payments — response body — paging, List Associations — commerce Payments get Associations By To Object Type — response body — results item

List Associations — commerce Payments get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association specifications, each including a label. These specify the types of associations and any labels that describe the nature of the association.
associationTypes[]	Model	Each item	Expand List Associations — commerce Payments get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the target object to which associations are being made. It is a string.

Referenced models: List Associations — commerce Payments get Associations By To Object Type — response body — results item association Types item

List Associations — commerce Payments get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	The category of the association, indicating its origin or purpose. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	The unique identifier for the object type from which the association originates.
label	string	Optional	A string label that describes the association between the objects.
toObjectTypeId	string	Optional	The unique identifier for the object type to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the association type. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — commerce Payments get Commerce Payments — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
paging	Model	Optional	Expand List — commerce Payments get Commerce Payments — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object along with its associated data.
results[]	Model	Each item	Expand Read — commerce Payments get Commerce Payment — response body

Referenced models: List — commerce Payments get Commerce Payments — response body — paging, Read — commerce Payments get Commerce Payment — response body

List — commerce Payments get Commerce Payments — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List — commerce Payments get Commerce Payments — response body — paging next

Referenced models: List — commerce Payments get Commerce Payments — response body — paging next

List — commerce Payments get Commerce Payments — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to indicate the starting point for the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Merge objects — commerce Payments merge — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether the object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object, represented as a string.
objectWriteTraceId	string	Optional	A string used for tracing the write operations on this object.
properties	object	Required within parent	An object containing key-value pairs of the object's properties, where each key is a property name and each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	An object where each key is a property name and each value is an array of historical values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — commerce Payments merge — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL associated with this object.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Merge objects — commerce Payments merge — response body — properties With History value item

Merge objects — commerce Payments merge — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string identifying the specific source of the value.
sourceLabel	string	Optional	A string providing a label or description for the source of the value.
sourceType	string	Required within parent	A string indicating the type of source from which the value originated.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	An integer representing the ID of the user who updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	A string representing the value associated with the timestamp.

Read batch objects — commerce Payments batch Get Commerce Payments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each representing an object to be read. The 'id' field within each object specifies the internal ID of the object.
inputs[]	Model	Each item	Expand Batch archive price book items — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned in the response. If any specified properties are not present on the requested objects, they will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. If any specified properties are not present on the requested objects, they will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Batch archive price book items — request body — body inputs item

Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs, providing documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Payments Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — commerce Payments merge — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Merge objects — commerce Payments merge — response body

Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Commerce Payments Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional resources or information related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — commerce Payments merge — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — commercePayments.batchGetCommercePayments — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge objects — commerce Payments merge — response body

Read — commerce Payments get Commerce Payment — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	Indicates whether this object has been archived. A boolean value.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to their associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — commerce Payments get Commerce Payment — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	An identifier used for tracing the write operation that created or updated this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays containing the property's value and timestamp history. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Merge objects — commerce Payments merge — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL of this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — commerce Payments get Commerce Payment — response body — associations value, Merge objects — commerce Payments merge — response body — properties With History value item

Read — commerce Payments get Commerce Payment — response body — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search objects — commerce Payments search Commerce Payments — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an object containing the ID and type of association.
results[]	Model	Each item	Expand Read — tickets get Ticket — response body — associations value results item

Referenced models: Read — tickets get Ticket — response body — associations value results item, Search objects — commerce Payments search Commerce Payments — response body — paging

Search objects — commerce Payments search Commerce Payments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token to retrieve the next set of results.
filterGroups	array	Required within parent	An array of filter groups used to refine the search results based on specific criteria.
filterGroups[]	Model	Each item	Expand Search objects — commerce Payments search Commerce Payments — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings indicating which properties of the objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to be applied to the CRM objects.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results.
sorts[]	string	Each item

Referenced models: Search objects — commerce Payments search Commerce Payments — request body — body filter Groups item

Search objects — commerce Payments search Commerce Payments — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of Filter objects that specify the conditions to be applied in the search query. Each filter defines a property, an operator, and a value or range of values to filter by.
filters[]	Model	Each item	Expand Search objects — commerce Payments search Commerce Payments — request body — body filter Groups item filters item

Referenced models: Search objects — commerce Payments search Commerce Payments — request body — body filter Groups item filters item

Search objects — commerce Payments search Commerce Payments — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional string representing the upper bound of a range when using range-based operators like 'BETWEEN'.
operator	string	Required within parent	The operator used to compare the property and the value(s). It is a string and valid values include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to which the filter is applied. It is a string that identifies the specific property of an object.
value	string	Optional	The value used in the filter condition. It is a string representing the specific value to compare against the property.
values	array	Optional	An array of strings representing multiple values for operators that support multiple comparisons, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search objects — commerce Payments search Commerce Payments — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search objects — commerce Payments search Commerce Payments — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current response.
results[]	Model	Each item	Expand Merge objects — commerce Payments merge — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search objects — commerce Payments search Commerce Payments — response body — paging, Merge objects — commerce Payments merge — response body

Search objects — commerce Payments search Commerce Payments — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand List — commerce Payments get Commerce Payments — response body — paging next
prev	Model	Optional	Expand Search objects — commerce Payments search Commerce Payments — response body — paging prev

Referenced models: List — commerce Payments get Commerce Payments — response body — paging next, Search objects — commerce Payments search Commerce Payments — response body — paging prev

Search objects — commerce Payments search Commerce Payments — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token that indicates the position of the last item on the previous page. It is used to retrieve the previous set of results in a paginated list.
link	string	Optional	A string URL that provides a direct link to access the previous page of results.

Update batch objects — commerce Payments batch Update Commerce Payments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput objects, each containing the properties of a single object to be processed in the batch.
inputs[]	Model	Each item	Expand Update batch objects — commerce Payments batch Update Commerce Payments — request body — body inputs item

Referenced models: Update batch objects — commerce Payments batch Update Commerce Payments — request body — body inputs item

Update batch objects — commerce Payments batch Update Commerce Payments — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	The id to be updated. This can be the object id, or the unique property value of the idProperty property
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string identifier used to trace the write operation for debugging or tracking purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the CRM object. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys