HubSpot: Search objects — commerce Payments search Commerce Payments

← Commerce payments operations · Get started

Operation hubspot.commerce_payments_search_commerce_payments

Provider route: POST /crm/objects/2026-09/commerce_payments/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["commercePayments"]["searchCommercePayments"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.commercePayments.searchCommercePayments(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.commerce_payments.search_commerce_payments(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Search objects — commerce Payments search Commerce Payments — request body — body

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

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search objects — commerce Payments search Commerce Payments — response body

Referenced models: Search objects — commerce Payments search Commerce Payments — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

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 — 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 — 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 — 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

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

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

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.

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.

Read — fees get Fee — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string indicating the category of the warning.
context	object	Required within parent	An object providing additional context for the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Policy, approvals and errors

SDK function policy ID: hubspot.commerce_payments_search_commerce_payments. Catalog operation: commerce_payments_search_commerce_payments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["crm.objects.commercepayments.read"]

Official provider source