> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve payment links
> Obtén una lista de enlaces de pago de tu cuenta de HubSpot. Este punto de terminación te permite filtrar y ordenar los enlaces de pago según varios criterios, como las marcas de tiempo de creación y actualización. Admite la paginación y puede incluir enlaces de pago archivados si se especifica.
export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-09/commerce-payment-links-v2026-09.json GET /commerce/payment-links/2026-09/payment-links
openapi: 3.0.1
info:
title: Commerce Payment Links
description: Basepom for all HubSpot Projects
version: 2026-09
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
paths:
/commerce/payment-links/2026-09/payment-links:
get:
tags:
- Basic
summary: Obtener todos los enlaces de pago
description: >-
Obtén una lista de enlaces de pago de tu cuenta de HubSpot. Este punto
de terminación te permite filtrar y ordenar los enlaces de pago según
varios criterios, como las marcas de tiempo de creación y actualización.
Admite la paginación y puede incluir enlaces de pago archivados si se
especifica.
operationId: get-/commerce/payment-links/2026-09/payment-links
parameters:
- name: after
in: query
description: >-
El token del cursor de paginación del último recurso leído con éxito
se devolverá como la propiedad JSON `paging.next.after` de una
respuesta paginada que contenga más resultados.
required: false
style: form
explode: true
schema:
type: string
- name: archived
in: query
description: Si se devolverán solo los resultados que se han archivado.
required: false
style: form
explode: true
schema:
type: boolean
default: false
- name: createdAfter
in: query
description: ''
required: false
style: form
explode: true
schema:
type: integer
format: int64
- name: createdAt
in: query
description: ''
required: false
style: form
explode: true
schema:
type: integer
format: int64
- name: createdBefore
in: query
description: ''
required: false
style: form
explode: true
schema:
type: integer
format: int64
- name: limit
in: query
description: El número máximo de resultados que se mostrarán por página.
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 20
- name: sort
in: query
description: ''
required: false
style: form
explode: true
schema:
type: string
- name: updatedAfter
in: query
description: ''
required: false
style: form
explode: true
schema:
type: integer
format: int64
- name: updatedAt
in: query
description: ''
required: false
style: form
explode: true
schema:
type: integer
format: int64
- name: updatedBefore
in: query
description: ''
required: false
style: form
explode: true
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: >-
#/components/schemas/CollectionResponsePaymentLinkResponseForwardPaging
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- payment-links-read
components:
schemas:
CollectionResponsePaymentLinkResponseForwardPaging:
required:
- results
type: object
properties:
paging:
$ref: '#/components/schemas/ForwardPaging'
results:
type: array
description: >-
Una matriz de objetos PaymentLinkResponse, cada uno representando un
enlace de pago con sus detalles asociados.
items:
$ref: '#/components/schemas/PaymentLinkResponse'
ForwardPaging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
description: >-
Información de paginación para la paginación de solo avance. Contiene la
referencia a la página siguiente cuando hay más resultados disponibles;
se omite o está vacía en la última página.
PaymentLinkResponse:
required:
- acceptedPaymentMethods
- additionalFormFields
- archived
- automatedSalesTaxEnabled
- checkoutFeeIds
- collectFullBillingAddress
- collectShippingAddress
- createContractOnPurchase
- currencyCode
- discountCodeEnabled
- discounts
- fees
- formGuid
- id
- includeEmailInSuccessRedirect
- isOneTimeUseEnabled
- lineItems
- paymentLinkName
- paymentLinkUrl
- state
- storePaymentMethodAtCheckout
- taxes
type: object
properties:
acceptedPaymentMethods:
type: array
description: >-
Una lista de métodos de pago aceptados para el enlace de pago. Los
valores válidos son "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" y
"PADS".
items:
type: string
enum:
- CREDIT_OR_DEBIT_CARD
- ACH
- SEPA
- BACS
- PADS
- AFFIRM
- KLARNA
additionalFormFields:
type: array
description: >-
Un conjunto de campos de formulario adicionales incluidos en el
enlace de pago.
items:
$ref: '#/components/schemas/PaymentLinkFormField'
archived:
type: boolean
description: Un valor booleano que indica si el enlace de pago está archivado.
archivedAt:
type: string
description: >-
La fecha y hora en que se archivó el enlace de pago, en formato ISO
8601.
format: date-time
automatedSalesTaxEnabled:
type: boolean
description: >-
Un booleano que indica si el impuesto de ventas automatizado está
habilitado para el enlace de pago.
businessUnitId:
type: string
description: >-
El ID de la unidad de negocio asociado al enlace de pago,
representado como una cadena.
checkoutFeeIds:
type: array
description: Un conjunto de ID de cargos de pago asociados al enlace de pago.
items:
type: string
collectFullBillingAddress:
type: boolean
description: >-
Un valor booleano que indica si se debe recoger la dirección de
facturación completa durante el proceso de pago.
collectShippingAddress:
type: boolean
description: >-
Un valor booleano que indica si se debe recoger la dirección de
envío durante el proceso de pago.
createContractOnPurchase:
type: boolean
createdAt:
type: string
description: >-
La fecha y hora en que se creó el enlace de pago, en formato ISO
8601.
format: date-time
currencyCode:
type: string
description: >-
El código de divisa para el enlace de pago, representado como una
cadena.
dealConfigurations:
$ref: '#/components/schemas/DealConfigurations'
descriptionHtml:
type: string
description: >-
La descripción HTML del enlace de pago, representada como una
cadena.
discountCodeEnabled:
type: boolean
description: >-
Un booleano que indica si los códigos de descuento están habilitados
en el enlace de pago.
discounts:
type: array
description: Un conjunto de objetos de descuento asociados al enlace de pago.
items:
$ref: '#/components/schemas/DiscountResponse'
domainId:
type: string
description: >-
El ID de dominio asociado al enlace de pago, representado como una
cadena.
fees:
type: array
description: Un conjunto de objetos de tarifas asociados con el enlace de pago.
items:
$ref: '#/components/schemas/FeeResponse'
formGuid:
type: string
description: >-
El GUID del formulario asociado al enlace de pago, representado como
una cadena.
id:
type: string
description: >-
El identificador único del enlace de pago, representado como una
cadena.
includeEmailInSuccessRedirect:
type: boolean
description: >-
Un valor booleano que indica si se debe incluir el correo
electrónico en la URL de redireccionamiento en caso de acción
correcta.
isOneTimeUseEnabled:
type: boolean
description: >-
Un valor booleano que indica si el enlace de pago está habilitado
para un solo uso.
lineItems:
type: array
description: Un conjunto de elementos de pedido asociados con el enlace de pago.
items:
$ref: '#/components/schemas/LineItem'
paymentLinkName:
type: string
description: El nombre del enlace de pago, representado como una cadena.
paymentLinkUrl:
type: string
description: La URL del enlace de pago, representada como una cadena.
state:
type: string
description: >-
El estado actual del enlace de pago, representado como una cadena.
Los valores válidos son "ON" y "OFF".
enum:
- 'OFF'
- 'ON'
storePaymentMethodAtCheckout:
type: boolean
description: >-
Un booleano que indica si se debe guardar el método de pago al
finalizar el pago.
successUrl:
type: string
description: >-
La URL a la que se hará redireccionamiento tras un pago exitoso,
representada como una cadena.
taxes:
type: array
description: Un conjunto de objetos de impuestos asociados con el enlace de pago.
items:
$ref: '#/components/schemas/TaxResponse'
updatedAt:
type: string
description: >-
La fecha y hora de la última actualización del enlace de pago, en
formato ISO 8601.
format: date-time
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: La categoría del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
Un identificador único para la solicitud. Incluye este valor con
cualquier informe de error o ticket de asistencia.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: información adicional acerca del error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
Un mapa de nombres de enlaces a las URI asociadas que contienen
documentación sobre el error o los pasos recomendados para
solucionarlo
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
example: An error occurred
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
description: >-
Representa una respuesta de error que devuelve la API cuando una
operación falla. Este componente se usa en varios puntos de terminación
para dar información detallada sobre el error que se encontró.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: >-
Un token de cadena que indica la posición después del último
elemento de la página actual y se usa para obtener la siguiente
página de resultados.
link:
type: string
description: >-
Una URL que proporciona un enlace directo a la siguiente página de
resultados.
description: >-
Specifies the paging information needed to retrieve the next set of
results in a paginated API response
PaymentLinkFormField:
required:
- isRequired
- label
- objectType
- options
- propertyName
type: object
properties:
description:
type: string
description: >-
Una descripción del campo del formulario, que proporciona contexto o
instrucciones adicionales, y se representa como una cadena de texto.
isRequired:
type: boolean
description: >-
Un valor booleano que indica si este campo del formulario es
obligatorio.
label:
type: string
description: >-
La etiqueta del campo del formulario, que se muestra a los usuarios,
representada como una cadena.
objectType:
type: string
description: >-
El tipo de objeto al que está asociado este campo de formulario,
representado como una cadena. Los valores válidos son "CONTACT" y
"COMPANY".
enum:
- COMPANY
- CONTACT
options:
type: array
description: >-
Una serie de opciones disponibles para este campo del formulario,
cada una representada como un objeto FormFieldOption.
items:
$ref: '#/components/schemas/FormFieldOption'
propertyName:
type: string
description: >-
El nombre de la propiedad asociada a este campo de formulario,
representado como una cadena de texto.
DealConfigurations:
required:
- createNewDealOnPurchase
type: object
properties:
createNewDealOnPurchase:
type: boolean
description: >-
Un booleano que indica si se debe crear un nuevo negocio en HubSpot
al realizar una compra. Es un campo obligatorio.
pipelineStageId:
type: string
description: >-
El identificador de la etapa del pipeline donde se colocará el nuevo
negocio. Es un valor de cadena.
DiscountResponse:
required:
- id
type: object
properties:
archived:
type: boolean
description: Indica si este descuento se archivó. Es un valor booleano.
archivedAt:
type: string
description: >-
La fecha y hora en que se archivó este descuento, en formato ISO
8601.
format: date-time
createdAt:
type: string
description: La fecha y hora en que se creó este descuento, en formato ISO 8601.
format: date-time
id:
type: string
description: El identificador único de este descuento.
label:
type: string
description: Una etiqueta descriptiva para el descuento.
updatedAt:
type: string
description: >-
La fecha y hora de la última actualización de este descuento, en
formato ISO 8601.
format: date-time
value:
type: number
description: El valor numérico del descuento.
valueType:
type: string
description: El tipo de valor de descuento, que puede ser "FIXED" o "PERCENT".
enum:
- FIXED
- PERCENT
FeeResponse:
required:
- id
type: object
properties:
archived:
type: boolean
description: Indica si esta tarifa se archivó. Es un valor booleano.
archivedAt:
type: string
description: La fecha y hora en que se archivó esta tarifa, en formato ISO 8601.
format: date-time
createdAt:
type: string
description: La fecha y hora en que se creó esta tarifa, en formato ISO 8601.
format: date-time
id:
type: string
description: El identificador único de esta tarifa.
label:
type: string
description: Una etiqueta descriptiva para la tarifa.
updatedAt:
type: string
description: >-
La fecha y hora de la última actualización de esta tarifa, en
formato ISO 8601.
format: date-time
value:
type: number
description: >-
El valor monetario de la tarifa. Un número que representa la
cantidad de la tarifa.
valueType:
type: string
description: El tipo de valor para la tarifa, que puede ser "FIXED" or "PERCENT".
enum:
- FIXED
- PERCENT
LineItem:
required:
- id
- name
- pricing
- quantity
type: object
properties:
acv:
type: number
description: El valor anual del contrato para el elemento de pedido.
allowBuyerSelectedQuantity:
type: boolean
description: >-
Indica si el comprador puede seleccionar la cantidad del elemento de
pedido.
amount:
type: number
description: >-
El importe total del elemento de pedido, calculado como precio
multiplicado por cantidad.
archived:
type: boolean
description: Indica si el elemento de pedido está archivado.
archivedAt:
type: string
description: >-
La fecha y hora en que se archivó el elemento de pedido, en formato
ISO 8601.
format: date-time
arr:
type: number
description: Los ingresos recurrentes anuales del elemento de pedido.
billingCycleAnchorDate:
type: string
description: >-
La fecha de anclaje para el ciclo de facturación, en formato de
fecha ISO 8601.
format: date
billingPeriodEndDate:
type: string
description: >-
La fecha de finalización del periodo de facturación, en formato de
fecha ISO 8601.
format: date
billingPeriodStartDate:
type: string
description: >-
La fecha de inicio del período de facturación, en formato de fecha
ISO 8601.
format: date
billingStartDelayDays:
type: integer
description: El número de días para retrasar el inicio de la facturación.
format: int32
billingStartDelayMonths:
type: integer
description: El número de meses para retrasar el inicio de la facturación.
format: int32
billingStartDelayType:
type: string
description: >-
El tipo de retraso para el inicio de la facturación. Los valores
válidos incluyen "HS_BILLING_START_DELAY_DAYS",
"HS_BILLING_START_DELAY_MONTHS" y "HS_RECURRING_BILLING_START_DATE".
enum:
- HS_BILLING_START_DELAY_DAYS
- HS_BILLING_START_DELAY_MONTHS
- HS_RECURRING_BILLING_START_DATE
buyerSelectedQuantityMax:
type: number
description: >-
La cantidad máxima que el comprador puede seleccionar para el
elemento de pedido.
buyerSelectedQuantityMin:
type: number
description: >-
La cantidad mínima que el comprador puede seleccionar para el
elemento de pedido.
createdAt:
type: string
description: >-
La fecha y hora en que se creó el elemento de pedido, en formato ISO
8601.
format: date-time
description:
type: string
description: Una descripción de texto del elemento de pedido.
discount:
type: number
description: El descuento aplicado al elemento de pedido.
discountPercentage:
type: number
description: El porcentaje de descuento aplicado al elemento de pedido.
effectiveUnitPrice:
type: number
description: El precio efectivo por unidad después de los descuentos.
externalId:
type: string
description: >-
Un identificador externo para el elemento de pedido, usado para
fines de integración.
id:
type: string
description: El identificador único del elemento de pedido.
images:
type: string
description: >-
Una URL o un identificador para las imágenes asociadas con el
elemento de pedido.
isEditablePrice:
type: boolean
description: Indica si el precio del elemento de pedido es editable.
isOptional:
type: boolean
description: Indica si el elemento de pedido es opcional.
isParent:
type: boolean
lineItemCurrencyCode:
type: string
description: >-
El código de divisa para el elemento de pedido, siguiendo el formato
ISO 4217.
mrr:
type: number
description: Los ingresos recurrentes mensuales del elemento de pedido.
name:
type: string
description: El nombre del elemento de pedido.
parentLineItemId:
type: string
positionOnQuote:
type: integer
description: >-
La posición del elemento de pedido en una cotización, representada
como un número entero.
format: int32
postTaxAmount:
type: number
description: La cantidad después de aplicar impuestos.
preDiscountAmount:
type: number
description: La cantidad antes de aplicar cualquier descuento.
price:
type: number
description: El precio de una sola unidad del elemento de pedido.
priceBookId:
type: string
description: >-
El identificador de la lista de precios asociada al elemento de
pedido.
pricing:
$ref: '#/components/schemas/Pricing'
pricingModel:
type: string
description: >-
El modelo de precios utilizado para el elemento de pedido. Los
valores válidos incluyen "FLAT", "GRADUATED", "STAIRSTEP" y
"VOLUME".
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
productId:
type: string
description: El identificador del producto asociado al elemento de pedido.
productType:
type: string
description: El tipo de producto para el elemento de pedido.
quantity:
type: number
description: La cantidad del elemento de pedido, representada como un número.
rampKey:
type: string
description: >-
Una clave que se usa para identificar el programa de aumento para el
elemento de pedido.
recurringBillingDayOfMonth:
type: integer
description: El día del mes en que se produce la facturación recurrente.
format: int32
recurringBillingEndDate:
type: string
description: >-
La fecha de finalización de la facturación recurrente, en formato de
fecha ISO 8601.
format: date
recurringBillingFrequency:
type: string
description: >-
La frecuencia de la facturación recurrente para el elemento de
pedido. Los valores válidos incluyen "ANNUALLY", "BIWEEKLY",
"MONTHLY", "PER_FIVE_YEARS", "PER_FOUR_YEARS", "PER_SIX_MONTHS",
"PER_THREE_YEARS", "PER_TWO_YEARS", "QUARTERLY" y "WEEKLY".
enum:
- ANNUALLY
- BIWEEKLY
- MONTHLY
- PER_FIVE_YEARS
- PER_FOUR_YEARS
- PER_SIX_MONTHS
- PER_THREE_YEARS
- PER_TWO_YEARS
- QUARTERLY
- WEEKLY
recurringBillingNumberOfPayments:
type: integer
description: El número de pagos para el ciclo de facturación recurrente.
format: int32
recurringBillingPeriod:
type: string
description: El periodo de facturación recurrente.
recurringBillingStartDate:
type: string
description: >-
La fecha de inicio de la facturación recurrente, en formato de fecha
ISO 8601.
format: date
recurringBillingTerms:
type: string
description: >-
Los términos de la facturación recurrente. Los valores válidos
incluyen "AUTOMATICALLY_RENEW" y "FIXED".
enum:
- AUTOMATICALLY_RENEW
- FIXED
richTextDescription:
type: string
description: >-
Una descripción con formato de texto enriquecido del elemento de
pedido.
sku:
type: string
description: >-
El identificador de la unidad de mantenimiento de existencias (SKU)
para el elemento de pedido.
tax:
type: number
description: La cantidad de impuesto aplicado al elemento de pedido.
taxAmount:
type: number
taxCategory:
type: string
taxRateGroupId:
type: string
tcv:
type: number
description: El valor total del contrato para el elemento de pedido.
termInMonths:
type: integer
description: La duración del plazo del elemento de pedido en meses.
format: int32
tierAmount:
type: number
description: La cantidad por niveles aplicable al elemento de pedido.
totalDiscount:
type: number
description: La cantidad total del descuento aplicada al elemento de pedido.
updatedAt:
type: string
description: >-
La fecha y hora de la última actualización del elemento de pedido,
en formato ISO 8601.
format: date-time
variantId:
type: string
description: >-
El identificador de la variante del producto asociado al elemento de
pedido.
TaxResponse:
required:
- id
type: object
properties:
archived:
type: boolean
description: >-
Indica si esta entrada de impuestos está archivada. Un valor
booleano.
archivedAt:
type: string
description: >-
La fecha y hora en que se archivó esta entrada de impuestos, en
formato ISO 8601.
format: date-time
createdAt:
type: string
description: >-
La fecha y hora en que se creó esta entrada de impuestos, en formato
ISO 8601.
format: date-time
id:
type: string
description: El identificador único para esta entrada de impuestos.
label:
type: string
description: Una etiqueta descriptiva para esta entrada de impuestos.
updatedAt:
type: string
description: >-
La fecha y hora de la última actualización de esta entrada de
impuestos, en formato ISO 8601.
format: date-time
value:
type: number
description: El valor numérico del impuesto.
valueType:
type: string
description: El tipo de valor del impuesto, que puede ser "FIXED" o "PERCENT".
enum:
- FIXED
- PERCENT
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: El código de estado asociado al detalle del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: El nombre del campo o parámetro en el que se encontró el error.
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
description: >-
Representa información detallada sobre un error que ocurrió en la API.
Este componente se usa para dar contexto adicional y detalles
específicos sobre los errores, normalmente como parte de una respuesta
de error.
FormFieldOption:
required:
- label
- value
type: object
properties:
description:
type: string
description: >-
Una cadena que proporciona información adicional o contexto sobre la
opción del campo del formulario.
label:
type: string
description: >-
Una cadena que representa el nombre visible de la opción del campo
del formulario.
value:
type: string
description: >-
Una cadena que representa el valor subyacente asociado con la opción
del campo del formulario.
Pricing:
required:
- prices
- pricingModel
type: object
properties:
prices:
type: array
description: >-
Un conjunto de entradas de precios, cada una detallando un punto de
precio específico dentro del modelo de precios.
items:
$ref: '#/components/schemas/PriceEntry'
pricingModel:
type: string
description: >-
El tipo de modelo de precios aplicado. Los valores válidos incluyen
"FLAT", "GRADUATED", "STAIRSTEP" y "VOLUME".
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
PriceEntry:
required:
- currencyCode
- price
type: object
properties:
currencyCode:
type: string
description: El código de divisa del precio, representado como una cadena.
maxQuantity:
type: integer
description: >-
La cantidad máxima a la que se aplica este precio, representada como
una cadena.
format: int32
price:
type: number
description: El precio del artículo, representado como un número.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
payment-links-delete: ''
payment-links-read: ''
payment-links-write: ''
````
{product.name} -
{product.level}
)}