How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Commerce Payment Links API

HubSpot Commerce Payment Links — 5 operation(s) from HubSpot's published OpenAPI.

HubSpot Commerce Payment Links API is one of 144 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 692 JSON Schema definitions.

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

This API exposes 5 operations across 2 paths, and defines 26 schemas. It is described by OpenAPI 3.0.1, at version 2026-09.

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

5 operations 2 paths 26 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2026-09
Base URL
https://api.hubapi.com
Authentication
API Key, OAuth 2.0, API Key, API Key
Resource Areas
1

Authentication & Security 4

HubSpot Commerce Payment Links API declares 4 security schemes for authenticating requests. An API key is passed in the query as hapikey (developer_hapikey). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as private-app (private_apps). An API key is passed in the header as private-app-legacy (private_apps_legacy).

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.

Basic 5
GET
/commerce/payment-links/2026-09/payment-links
Retrieve all payment links
get-/commerce/payment-links/2026-09/payment-links 10 params → 200default
POST
/commerce/payment-links/2026-09/payment-links
Create a payment link
post-/commerce/payment-links/2026-09/payment-links body → 201default
GET
/commerce/payment-links/2026-09/payment-links/{paymentLinkId}
Retrieve payment link
get-/commerce/payment-links/2026-09/payment-links/{paymentLinkId} 2 params → 200default
DELETE
/commerce/payment-links/2026-09/payment-links/{paymentLinkId}
Delete a payment link
delete-/commerce/payment-links/2026-09/payment-links/{paymentLinkId} 1 param → 204default
PATCH
/commerce/payment-links/2026-09/payment-links/{paymentLinkId}
Update a payment link
patch-/commerce/payment-links/2026-09/payment-links/{paymentLinkId}_/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId} 1 param body → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are LineItem (59 properties), PaymentLinkResponse (32 properties), LineItemCloneCreateRequest (31 properties), LineItemCustomCreateRequest (31 properties). Each schema is shown below with its type and property counts.

CollectionResponsePaymentLinkResponseForwardPaging
object
2 properties 1 required
DealConfigurations
object
2 properties 1 required
DiscountRequest
object
3 properties 3 required
DiscountResponse
object
8 properties 1 required
Error
object
Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the…
7 properties 3 required
ErrorDetail
object
Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typic…
5 properties 1 required
ExpirationSettings
object
2 properties
FeeRequest
object
3 properties 3 required
FeeResponse
object
8 properties 1 required
FormFieldOption
object
3 properties 2 required
ForwardPaging
object
Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
1 property
LineItem
object
59 properties 4 required
LineItemCloneCreateRequest
object
31 properties 31 required
LineItemCustomCreateRequest
object
31 properties 4 required
LineItemFromProductCreateRequest
object
31 properties 31 required
NextPage
object
Specifies the paging information needed to retrieve the next set of results in a paginated API response
2 properties 1 required
PaymentLinkCreateRequest
object
28 properties 14 required
PaymentLinkFormField
object
6 properties 5 required
PaymentLinkResponse
object
32 properties 23 required
PaymentLinkUpdateRequest
object
28 properties 7 required
PriceEntry
object
3 properties 2 required
PriceUpdateEntry
object
3 properties 2 required
Pricing
object
2 properties 2 required
PricingFullUpdateRequest
object
2 properties 2 required
TaxRequest
object
3 properties 3 required
TaxResponse
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-commerce-payment-links-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

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
HubSpot Workflows API
Where this information came from

This is an independent, third-party profile of HubSpot Commerce Payment Links API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.