> ## 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.
# Create a payment link
> Crea un nuevo enlace de pago en tu cuenta de HubSpot. Este punto de terminación te permite especificar varios atributos para el enlace de pago, como los métodos de pago aceptados, la divisa y campos de formulario adicionales. El enlace de pago se puede configurar para un solo uso y también puede recoger direcciones de envío y facturación. Esta operación requiere un cuerpo de solicitud JSON válido. Se aplicarán algunos valores predeterminados si no se proporciona ningún valor.
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 POST /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:
post:
tags:
- Basic
summary: Crear enlace de pago
description: >-
Crea un nuevo enlace de pago en tu cuenta de HubSpot. Este punto de
terminación te permite especificar varios atributos para el enlace de
pago, como los métodos de pago aceptados, la divisa y campos de
formulario adicionales. El enlace de pago se puede configurar para un
solo uso y también puede recoger direcciones de envío y facturación.
Esta operación requiere un cuerpo de solicitud JSON válido. Se aplicarán
algunos valores predeterminados si no se proporciona ningún valor.
operationId: post-/commerce/payment-links/2026-09/payment-links
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentLinkCreateRequest'
required: true
responses:
'201':
description: successful operation
headers:
Location:
description: URL of the newly created resource
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentLinkResponse'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- payment-links-write
components:
schemas:
PaymentLinkCreateRequest:
required:
- acceptedPaymentMethods
- additionalFormFields
- currencyCode
- discountObjectIds
- enableDefaultCheckoutFees
- feeObjectIds
- fees
- includeEmailInSuccessRedirect
- isOneTimeUseEnabled
- lineItemObjectIds
- lineItems
- paymentLinkName
- state
- taxObjectIds
- 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 objetos PaymentLinkFormField que representan campos
de formulario adicionales que se incluirán en el enlace de pago.
items:
$ref: '#/components/schemas/PaymentLinkFormField'
automatedSalesTaxEnabled:
type: boolean
description: >-
Un valor booleano que indica si el impuesto sobre las ventas
automatizado está habilitado.
businessUnitId:
type: string
description: >-
Una cadena que representa el ID de la unidad de negocio asociada al
enlace de pago.
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
currencyCode:
type: string
description: El código de divisa para el pago, representado como una cadena.
dealConfigurations:
$ref: '#/components/schemas/DealConfigurations'
descriptionHtml:
type: string
description: Una cadena que contiene la descripción HTML del enlace de pago.
discount:
$ref: '#/components/schemas/DiscountRequest'
discountCodeEnabled:
type: boolean
description: >-
Un booleano que indica si los códigos de descuento están habilitados
en el enlace de pago.
discountObjectId:
type: string
description: >-
Una cadena que representa el ID de objeto de un descuento asociado
con el enlace de pago.
discountObjectIds:
type: array
description: >-
Un conjunto de cadenas que representan los ID de los objetos de
descuento asociados con el enlace de pago.
items:
type: string
domainId:
type: string
description: >-
El ID de dominio asociado al enlace de pago, representado como una
cadena.
enableDefaultCheckoutFees:
type: boolean
description: >-
Un valor booleano que indica si las tarifas de pago predeterminadas
están habilitadas.
feeObjectIds:
type: array
description: >-
Una matriz de cadenas que representan los ID de los objetos de
tarifas asociados con el enlace de pago.
items:
type: string
fees:
type: array
description: >-
Un conjunto de objetos FeeRequest que representan las tarifas que se
aplicarán al enlace de pago.
items:
$ref: '#/components/schemas/FeeRequest'
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.
lineItemObjectIds:
type: array
description: >-
Un conjunto de ID de objetos de elementos de pedido asociados al
enlace de pago, cada uno representado como una cadena.
items:
type: string
lineItems:
type: array
description: >-
Un conjunto de elementos de pedido, que pueden ser personalizadas,
de un producto o clonadas, según lo definan sus respectivos
esquemas.
items:
oneOf:
- $ref: '#/components/schemas/LineItemCustomCreateRequest'
- $ref: '#/components/schemas/LineItemFromProductCreateRequest'
- $ref: '#/components/schemas/LineItemCloneCreateRequest'
paymentLinkName:
type: string
description: El nombre del enlace de pago. Es un valor de cadena.
state:
type: string
description: >-
El estado 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: >-
Una cadena que define la URL a la que se hará redireccionamiento
tras un pago exitoso.
taxObjectIds:
type: array
description: >-
Un conjunto de ID de cadena que representan objetos de impuestos
asociados con el enlace de pago.
items:
type: string
taxes:
type: array
description: >-
Un conjunto de objetos TaxRequest, cada uno representando un
impuesto asociado al enlace de pago.
items:
$ref: '#/components/schemas/TaxRequest'
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
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.
DiscountRequest:
required:
- label
- value
- valueType
type: object
properties:
label:
type: string
description: Una etiqueta descriptiva para el descuento. Es una cadena.
value:
type: number
description: El valor numérico del descuento que se aplicará. Es un número.
valueType:
type: string
description: El tipo de valor de descuento, que puede ser "FIXED" o "PERCENT".
enum:
- FIXED
- PERCENT
FeeRequest:
required:
- label
- value
- valueType
type: object
properties:
label:
type: string
description: >-
Una etiqueta descriptiva para la tarifa, representada como una
cadena.
value:
type: number
description: >-
El valor numérico de la tarifa. Es un número que representa una
cantidad fija o un porcentaje, según el valueType.
valueType:
type: string
description: >-
El tipo de valor de la tarifa, que indica si es una cantidad fija o
un porcentaje. Los valores válidos incluyen "FIXED" y "PERCENT".
enum:
- FIXED
- PERCENT
LineItemCustomCreateRequest:
title: CUSTOM
required:
- mode
- name
- pricing
- quantity
type: object
properties:
allowBuyerSelectedQuantity:
type: boolean
description: >-
Un valor booleano que especifica si el comprador puede seleccionar
la cantidad del elemento de pedido.
billingCycleAnchorDate:
type: string
description: >-
Una cadena en formato de fecha que representa la fecha de anclaje
para el ciclo de facturación.
format: date
billingStartDelayDays:
type: integer
description: >-
Un número entero que indica la cantidad de días para retrasar el
inicio de la facturación.
format: int32
billingStartDelayMonths:
type: integer
description: >-
Un número entero que indica la cantidad de meses para retrasar el
inicio de la facturación.
format: int32
buyerSelectedQuantityMax:
type: number
description: >-
Un número que indica la cantidad máxima que el comprador puede
seleccionar.
buyerSelectedQuantityMin:
type: number
description: >-
Un número que indica la cantidad mínima que el comprador puede
seleccionar.
description:
type: string
description: Una cadena que proporciona una descripción del elemento de pedido.
discount:
type: number
description: >-
Un número que representa el descuento aplicado al elemento de
pedido.
discountPercentage:
type: number
description: >-
Un número que indica el porcentaje de descuento aplicado al elemento
de pedido.
externalId:
type: string
description: >-
Una cadena que representa un identificador externo para el elemento
de pedido.
images:
type: string
description: >-
Una cadena que contiene URL o identificadores para imágenes
asociadas con el elemento de pedido.
isEditablePrice:
type: boolean
description: >-
Un valor booleano que indica si el precio del elemento de pedido es
editable.
isOptional:
type: boolean
description: Un valor booleano que indica si el elemento de pedido es opcional.
lineItemCurrencyCode:
type: string
description: >-
Una cadena que representa el código de divisa del elemento de
pedido.
mode:
type: string
description: >-
Una cadena que indica el modo del elemento de pedido, que está
configurado como "CUSTOM".
default: CUSTOM
enum:
- CUSTOM
name:
type: string
description: Una cadena que representa el nombre del elemento de pedido.
positionOnQuote:
type: integer
description: >-
Un número entero que indica la posición del elemento de pedido en
una cotización.
format: int32
priceBookId:
type: string
description: >-
Una cadena que identifica la lista de precios asociada al elemento
de pedido.
pricing:
$ref: '#/components/schemas/PricingFullUpdateRequest'
productId:
type: string
description: >-
Una cadena que identifica el producto asociado con el elemento de
pedido.
productType:
type: string
description: >-
Una cadena que indica el tipo de producto para el elemento de
pedido.
quantity:
type: number
description: Un número que indica la cantidad del elemento de pedido.
recurringBillingEndDate:
type: string
description: >-
Una cadena en formato de fecha que indica la fecha de finalización
de la facturación recurrente.
format: date
recurringBillingFrequency:
type: string
description: >-
Una cadena que especifica la frecuencia de la facturación
recurrente. 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
recurringBillingPeriod:
type: string
description: Una cadena que representa el periodo de facturación recurrente.
recurringBillingStartDate:
type: string
description: >-
Una cadena en formato de fecha que indica la fecha de inicio de la
facturación recurrente.
format: date
richTextDescription:
type: string
description: >-
Una cadena que contiene una descripción de texto enriquecido del
elemento de pedido.
sku:
type: string
description: >-
Una cadena que representa la unidad de mantenimiento de existencias
(SKU) del elemento de pedido.
taxCategory:
type: string
taxRateGroupId:
type: string
variantId:
type: string
description: Una cadena que representa el identificador de variante del producto.
x-hubspot-sub-type-impl: true
LineItemFromProductCreateRequest:
title: FROM_PRODUCT
required:
- allowBuyerSelectedQuantity
- billingCycleAnchorDate
- billingStartDelayDays
- billingStartDelayMonths
- buyerSelectedQuantityMax
- buyerSelectedQuantityMin
- description
- discount
- discountPercentage
- externalId
- images
- isEditablePrice
- isOptional
- lineItemCurrencyCode
- mode
- name
- positionOnQuote
- priceBookId
- pricing
- productId
- productType
- quantity
- recurringBillingEndDate
- recurringBillingFrequency
- recurringBillingPeriod
- recurringBillingStartDate
- richTextDescription
- sku
- taxCategory
- taxRateGroupId
- variantId
type: object
properties:
allowBuyerSelectedQuantity:
type: object
properties: {}
description: >-
Un objeto que indica si el comprador puede seleccionar la cantidad
del producto.
billingCycleAnchorDate:
type: object
properties: {}
description: >-
Un objeto que representa la fecha de anclaje del ciclo de
facturación.
billingStartDelayDays:
type: object
properties: {}
description: >-
Un objeto que representa el número de días para retrasar el inicio
de la facturación.
billingStartDelayMonths:
type: object
properties: {}
description: >-
Un objeto que representa el número de meses para retrasar el inicio
de la facturación.
buyerSelectedQuantityMax:
type: object
properties: {}
description: >-
Un objeto que representa la cantidad máxima que el comprador puede
seleccionar.
buyerSelectedQuantityMin:
type: object
properties: {}
description: >-
Un objeto que representa la cantidad mínima que el comprador puede
seleccionar.
description:
type: object
properties: {}
description: >-
Un objeto que representa la descripción del producto asociado al
elemento de pedido.
discount:
type: object
properties: {}
description: >-
Un objeto que representa cualquier descuento aplicado al elemento de
pedido.
discountPercentage:
type: object
properties: {}
description: >-
Un objeto que representa el porcentaje de descuento aplicado al
elemento de pedido.
externalId:
type: object
properties: {}
description: >-
Un objeto que representa un identificador externo para el elemento
de pedido.
images:
type: object
properties: {}
description: Un objeto que representa las imágenes asociadas con el producto.
isEditablePrice:
type: object
properties: {}
description: >-
Un objeto que indica si el precio del elemento de pedido es
editable.
isOptional:
type: object
properties: {}
description: Un objeto que indica si el elemento de pedido es opcional.
lineItemCurrencyCode:
type: object
properties: {}
description: >-
Un objeto que representa el código de divisa para el elemento de
pedido.
mode:
type: string
description: >-
Una cadena que indica el modo de creación del elemento de pedido. El
valor predeterminado y único válido es "FROM_PRODUCT".
default: FROM_PRODUCT
enum:
- FROM_PRODUCT
name:
type: object
properties: {}
description: >-
Un objeto que representa el nombre del producto asociado con el
elemento de pedido.
positionOnQuote:
type: object
properties: {}
description: >-
Un objeto que representa la posición del elemento de pedido en una
cotización.
priceBookId:
type: object
properties: {}
description: >-
Un objeto que representa el ID del catálogo de precios asociado con
el producto.
pricing:
type: object
properties: {}
description: >-
Un objeto que representa los detalles de precios del elemento de
pedido.
productId:
type: string
description: Una cadena que representa el identificador único del producto.
productType:
type: object
properties: {}
description: Un objeto que representa el tipo de producto.
quantity:
type: object
properties: {}
description: >-
Un objeto que representa la cantidad del producto que se incluirá en
el elemento de pedido.
recurringBillingEndDate:
type: object
properties: {}
description: >-
Un objeto que representa la fecha de finalización del ciclo de
facturación recurrente.
recurringBillingFrequency:
type: object
properties: {}
description: >-
Un objeto que representa la frecuencia de la facturación recurrente
del elemento de pedido.
recurringBillingPeriod:
type: object
properties: {}
description: >-
Un objeto que representa el periodo del ciclo de facturación
recurrente.
recurringBillingStartDate:
type: object
properties: {}
description: >-
Un objeto que representa la fecha de inicio del ciclo de facturación
recurrente.
richTextDescription:
type: object
properties: {}
description: >-
Un objeto que representa una descripción de texto enriquecido del
producto asociado con el elemento de pedido.
sku:
type: object
properties: {}
description: >-
Un objeto que representa la unidad de mantenimiento de existencias
(SKU) del producto.
taxCategory:
type: object
properties: {}
taxRateGroupId:
type: object
properties: {}
variantId:
type: object
properties: {}
description: Un objeto que representa el ID de variante del producto.
x-hubspot-sub-type-impl: true
LineItemCloneCreateRequest:
title: CLONE
required:
- allowBuyerSelectedQuantity
- billingCycleAnchorDate
- billingStartDelayDays
- billingStartDelayMonths
- buyerSelectedQuantityMax
- buyerSelectedQuantityMin
- description
- discount
- discountPercentage
- externalId
- images
- isEditablePrice
- isOptional
- lineItemCurrencyCode
- mode
- name
- positionOnQuote
- priceBookId
- pricing
- productType
- quantity
- recurringBillingEndDate
- recurringBillingFrequency
- recurringBillingPeriod
- recurringBillingStartDate
- richTextDescription
- sku
- sourceLineItemId
- taxCategory
- taxRateGroupId
- variantId
type: object
properties:
allowBuyerSelectedQuantity:
type: object
properties: {}
description: >-
Un objeto que indica si el comprador puede seleccionar la cantidad
del elemento de pedido.
billingCycleAnchorDate:
type: object
properties: {}
description: >-
Un objeto que representa la fecha de anclaje para el ciclo de
facturación del elemento de pedido.
billingStartDelayDays:
type: object
properties: {}
description: >-
Un objeto que representa el número de días para el retraso del
inicio de la facturación del elemento de pedido.
billingStartDelayMonths:
type: object
properties: {}
description: >-
Un objeto que representa el número de meses para retrasar el inicio
de la facturación del elemento de pedido.
buyerSelectedQuantityMax:
type: object
properties: {}
description: >-
Un objeto que representa la cantidad máxima que el comprador puede
seleccionar para el elemento de pedido.
buyerSelectedQuantityMin:
type: object
properties: {}
description: >-
Un objeto que representa la cantidad mínima que el comprador puede
seleccionar para el elemento de pedido.
description:
type: object
properties: {}
description: Un objeto que representa la descripción del elemento de pedido.
discount:
type: object
properties: {}
description: >-
Un objeto que representa el descuento aplicado al elemento de
pedido.
discountPercentage:
type: object
properties: {}
description: >-
Un objeto que representa el porcentaje de descuento aplicado al
elemento de pedido.
externalId:
type: object
properties: {}
description: >-
Un objeto que representa un identificador externo para el elemento
de pedido.
images:
type: object
properties: {}
description: >-
Un objeto que representa las imágenes asociadas con el elemento de
pedido.
isEditablePrice:
type: object
properties: {}
description: >-
Un objeto que indica si el precio del elemento de pedido es
editable.
isOptional:
type: object
properties: {}
description: Un objeto que indica si el elemento de pedido es opcional.
lineItemCurrencyCode:
type: object
properties: {}
description: >-
Un objeto que representa el código de divisa para el elemento de
pedido.
mode:
type: string
description: >-
Una cadena que indica el modo de creación del elemento de pedido,
que es "CLONE" para este componente.
default: CLONE
enum:
- CLONE
name:
type: object
properties: {}
description: Un objeto que representa el nombre del elemento de pedido.
positionOnQuote:
type: object
properties: {}
description: >-
Un objeto que representa la posición del elemento de pedido en la
cotización.
priceBookId:
type: object
properties: {}
description: >-
Un objeto que representa el ID del catálogo de precios asociado con
el elemento de pedido.
pricing:
type: object
properties: {}
description: >-
Un objeto que representa los detalles de precios del elemento de
pedido.
productType:
type: object
properties: {}
description: >-
Un objeto que representa el tipo de producto para el elemento de
pedido.
quantity:
type: object
properties: {}
description: Un objeto que representa la cantidad del elemento de pedido.
recurringBillingEndDate:
type: object
properties: {}
description: >-
Un objeto que representa la fecha de finalización de la facturación
recurrente del elemento de pedido.
recurringBillingFrequency:
type: object
properties: {}
description: >-
Un objeto que representa la frecuencia de la facturación recurrente
del elemento de pedido.
recurringBillingPeriod:
type: object
properties: {}
description: >-
Un objeto que representa el periodo de facturación para la
facturación recurrente del elemento de pedido.
recurringBillingStartDate:
type: object
properties: {}
description: >-
Un objeto que representa la fecha de inicio de la facturación
recurrente del elemento de pedido.
richTextDescription:
type: object
properties: {}
description: >-
Un objeto que representa la descripción de texto enriquecido del
elemento de pedido.
sku:
type: object
properties: {}
description: >-
Un objeto que representa la unidad de mantenimiento de existencias
(SKU) del elemento de pedido.
sourceLineItemId:
type: string
description: >-
Una cadena que representa el ID del elemento de pedido de origen que
se está clonando.
taxCategory:
type: object
properties: {}
taxRateGroupId:
type: object
properties: {}
variantId:
type: object
properties: {}
description: Un objeto que representa el ID de variante del elemento de pedido.
x-hubspot-sub-type-impl: true
TaxRequest:
required:
- label
- value
- valueType
type: object
properties:
label:
type: string
description: >-
Una cadena que proporciona una etiqueta o descripción para el
impuesto, utilizada con fines de identificación o visualización.
value:
type: number
description: >-
El valor numérico del impuesto. Representa la cantidad o el
porcentaje, según el valueType.
valueType:
type: string
description: >-
Una cadena que indica el tipo de valor del impuesto. Los valores
válidos son "FIXED" para una cantidad fija y "PERCENT" para un
impuesto basado en porcentaje.
enum:
- FIXED
- PERCENT
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
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
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.
PricingFullUpdateRequest:
required:
- prices
- pricingModel
type: object
properties:
prices:
type: array
description: >-
Un conjunto de objetos PriceUpdateEntry, cada uno especificando los
detalles del precio, como el código de divisa y la cantidad del
precio para diferentes cantidades.
items:
$ref: '#/components/schemas/PriceUpdateEntry'
pricingModel:
type: string
description: >-
El modelo de precios aplicado al elemento de pedido. Los valores
válidos son "FLAT", "GRADUATED", "STAIRSTEP" y "VOLUME".
enum:
- FLAT
- GRADUATED
- STAIRSTEP
- VOLUME
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
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.
PriceUpdateEntry:
required:
- currencyCode
- price
type: object
properties:
currencyCode:
type: string
description: >-
El código de la divisa en la que se especifica el 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: object
properties: {}
description: >-
Un objeto que representa los detalles del precio. La estructura
específica de este objeto no se detalla en la especificación.
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}
)}