Commerce Payments

Name: Commerce Payments API
Brand: HubSpot Commerce Payments
Availability: InStock

✓ Official Vendor SpecPaymentsPayment Processingoauth2,apiKey11 EndpointsREST

For Agents

Create, read, update, archive, search, and upsert HubSpot Commerce payment records, mirroring captured payments from a processor into the CRM ledger.

Quickstart

Get started with Commerce Payments in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"record a payment in hubspot commerce"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Commerce Payments API.

Record captured payments with amount, currency, method, and processor reference properties

Batch upsert payments by an external processor reference id to avoid duplicates from retried webhooks

Search payments by date, amount range, contact, or deal using filter groups

Retrieve a payment record with associated contacts, deals, and invoices in one call

GET STARTED

Start building with Commerce Payments API

Explore with Jentic

View OpenAPI Document

Use for: I need to record a captured payment in HubSpot Commerce, Retrieve a commerce payment record by its CRM ID, Search for payments above a threshold in the last 30 days, Update a payment record with the refund amount

Not supported: Does not capture, refund, or settle payments at a processor — use only for managing HubSpot CRM payment records that mirror processor activity.

The HubSpot Commerce Payments API exposes payment records inside HubSpot Commerce, representing captured payments that can be associated with contacts, deals, and invoices. It follows the standard CRM v3 object pattern with batch read, create, update, archive, search, and upsert operations against the commerce_payments object. Records carry properties such as amount, currency, payment method, processor, and reference id, providing a CRM-side ledger that mirrors the payments captured by your processor.

Use Cases

Patterns agents use Commerce Payments API for, with concrete tasks.

★ Processor Payment Mirror

Mirror captured payments from a processor like Stripe or Adyen into HubSpot so the CRM has a record of every payment alongside the contact and deal. Batch upsert by the processor's charge id ensures retried webhooks do not duplicate records, even at high volume.

POST 100 payment payloads to /crm/v3/objects/commerce_payments/batch/upsert with idProperty set to processor_charge_id and the deal association id.

Refund Recording

When a refund is issued by the processor, update the corresponding payment record with the refund amount and date so the CRM ledger remains accurate. Search by processor charge id to find the right record before the update.

Search /crm/v3/objects/commerce_payments/search by processor_charge_id, then PATCH the matching record with hs_refund_amount and hs_refund_date.

Revenue Reporting

Generate a CRM-side revenue report by searching commerce payments filtered by date and currency, summing hs_amount per deal owner. The search endpoint supports paging and property selection so the report is efficient.

Search /crm/v3/objects/commerce_payments/search with filterGroups on hs_payment_date in the last 30 days and currency = USD, returning hs_amount and ownerId.

AI Agent Payment Reconciliation

An AI agent reconciles processor exports against HubSpot commerce payments daily, surfacing missing or mismatched records to a human reviewer. Jentic exposes the search and upsert operations with typed schemas, so the agent can detect gaps and create missing records without doc lookup.

Diff yesterday's processor charges against /crm/v3/objects/commerce_payments/search results; for each missing charge, upsert via /batch/upsert with idProperty = processor_charge_id.

Key Endpoints

11 endpoints — the hubspot commerce payments api exposes payment records inside hubspot commerce, representing captured payments that can be associated with contacts, deals, and invoices.

METHOD

PATH

DESCRIPTION

POST

/crm/v3/objects/commerce_payments/batch/create

Create payment records in batch

POST

/crm/v3/objects/commerce_payments/batch/upsert

Idempotent upsert by external id

POST

/crm/v3/objects/commerce_payments/batch/read

Read payments in batch by ID

POST

/crm/v3/objects/commerce_payments/batch/update

Update payment properties in batch

POST

/crm/v3/objects/commerce_payments/search

Search payments by filter groups

GET

/crm/v3/objects/commerce_payments/{commercePaymentId}

Retrieve a single payment

GET

/crm/v3/objects/commerce_payments

List payments with pagination

POST

/crm/v3/objects/commerce_payments/batch/create

Create payment records in batch

POST

/crm/v3/objects/commerce_payments/batch/upsert

Idempotent upsert by external id

POST

/crm/v3/objects/commerce_payments/batch/read

Read payments in batch by ID

POST

/crm/v3/objects/commerce_payments/batch/update

Update payment properties in batch

POST

/crm/v3/objects/commerce_payments/search

Search payments by filter groups

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

HubSpot OAuth and private app tokens are encrypted in the Jentic vault. Scoped tokens are injected at execution — raw credentials never appear in agent prompts or logs.

Intent-based discovery

Agents search Jentic by intent (e.g. 'record a payment in hubspot') and Jentic returns the matching commerce_payments operation with its typed input schema, so the agent calls the right endpoint without doc lookup.

Time to first call

Direct integration: 2-3 days for OAuth, idempotent upsert against processor webhooks, and association handling. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Commerce Subscriptions

Manages recurring subscription records that drive recurring payment events.

Use Subscriptions when the agent is mirroring recurring billing rather than one-off captured payments.

Complementary

Invoices

Tracks invoice records that payments are commonly applied to.

Use Invoices alongside payments when the agent needs to mark an invoice as paid after recording the payment.

Alternative

Stripe

Stripe processes payments directly; HubSpot Commerce Payments is the CRM-side mirror.

Choose Stripe when the agent must capture or refund a payment at the processor; choose HubSpot Commerce Payments to mirror that event into CRM.

FAQs

Specific to using Commerce Payments API through Jentic.

What authentication does the HubSpot Commerce Payments API use?

It supports OAuth 2.0 and HubSpot private app tokens. Through Jentic, tokens are stored encrypted in the vault and scoped tokens are injected at execution time, so the raw credential never enters the agent's context.

Can I record refunds with the HubSpot Commerce Payments API?

Yes. Update the payment record with hs_refund_amount and hs_refund_date via PATCH /crm/v3/objects/commerce_payments/{commercePaymentId}. The Commerce Payments API does not initiate refunds at the processor — issue the refund through your processor first, then update the HubSpot record.

What are the rate limits for the HubSpot Commerce Payments API?

Standard CRM v3 limits apply — 100 requests per 10 seconds for OAuth apps and 110 per 10 seconds for private apps. Use the batch upsert endpoint (up to 100 records per call) when mirroring high-volume processor activity.

How do I upsert payments through Jentic?

Run the Jentic search "upsert hubspot commerce payment" to find POST /crm/v3/objects/commerce_payments/batch/upsert, load the schema, and execute with idProperty set to your processor's charge id. Jentic handles authentication.

Is the HubSpot Commerce Payments API free?

Access requires HubSpot Commerce Hub. There is no per-call HubSpot fee on top of the Commerce subscription, but processor fees from your payment provider apply separately.

Can I associate a payment with a deal and an invoice?

Yes — pass an associations array on create, or use the CRM Associations API afterwards, to link a single payment to a deal, invoice, and contact. The single-record GET supports an associations parameter to return linked IDs in one call.