Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Single Payment Operations API

CRUD operations for individual commerce payment records

HubSpot Single Payment Operations API is one of 93 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 652 JSON Schema definitions.

Tagged areas include Single Payment Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.hubapi.com.

5 operations 2 paths 11 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot Single Payment Operations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Single Payment Operations 5

CRUD operations for individual commerce payment records

GET
/crm/v3/objects/commerce_payments
Hubspot List Commerce Payments
listCommercePayments 6 params → 200400401500
POST
/crm/v3/objects/commerce_payments
Hubspot Create a Commerce Payment
createCommercePayment body → 201400401500
GET
/crm/v3/objects/commerce_payments/{commercePaymentId}
Hubspot Retrieve a Commerce Payment
getCommercePaymentById 6 params → 200400401404500
PATCH
/crm/v3/objects/commerce_payments/{commercePaymentId}
Hubspot Update a Commerce Payment
updateCommercePaymentById 2 params body → 200400401404500
DELETE
/crm/v3/objects/commerce_payments/{commercePaymentId}
Hubspot Archive a Commerce Payment
archiveCommercePaymentById 1 param → 204401404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CommercePayment (8 properties), Error (7 properties), PropertyHistory (6 properties), ErrorDetail (5 properties). Each schema is shown below with its type and property counts.

PropertyHistory
object
A historical property value
6 properties 3 required
CommercePaymentCollection
object
A paginated collection of commerce payments
2 properties 1 required
ErrorDetail
object
Detailed error information
5 properties 1 required
CommercePaymentPatch
object
Input for updating a commerce payment
1 property 1 required
Paging
object
Pagination information
2 properties
AssociationResult
object
Association results for an object
2 properties
AssociationInput
object
Input for creating an association
2 properties 2 required
Error
object
An error response
7 properties 3 required
AssociationType
object
An association type definition
2 properties 2 required
CommercePayment
object
A commerce payment object representing a payment transaction
8 properties 4 required
CommercePaymentInput
object
Input for creating a new commerce payment
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-single-payment-operations-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot Posts API
HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API