> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a payment link > Atualize um link de pagamento por ID. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2026-09/commerce-payment-links-v2026-09.json PATCH /commerce/payment-links/2026-09/payment-links/{paymentLinkId} 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/{paymentLinkId}: patch: tags: - Basic summary: Atualizar um link de pagamento description: Atualize um link de pagamento por ID. operationId: >- patch-/commerce/payment-links/2026-09/payment-links/{paymentLinkId}_/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId} parameters: - name: paymentLinkId in: path description: O identificador exclusivo do link de pagamento a ser atualizado. required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentLinkUpdateRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResponse' default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: PaymentLinkUpdateRequest: required: - businessUnitId - dealConfigurations - descriptionHtml - discountObjectId - domainId - expirationSettings - successUrl type: object properties: acceptedPaymentMethods: type: array description: >- Uma matriz de strings que indica os métodos de pagamento aceitos. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" e "PADS". items: type: string enum: - CREDIT_OR_DEBIT_CARD - ACH - SEPA - BACS - PADS - AFFIRM - KLARNA additionalFormFields: type: array description: >- Uma matriz de objetos PaymentLinkFormField que representam campos de formulário adicionais para o link de pagamento. items: $ref: '#/components/schemas/PaymentLinkFormField' automatedSalesTaxEnabled: type: boolean description: >- Um booleano que indica se o imposto de vendas automatizado está ativado. businessUnitId: type: object properties: {} description: >- Um objeto que representa o ID da unidade de negócio associado ao link de pagamento. collectFullBillingAddress: type: boolean description: >- Um booleano que indica se o endereço de cobrança completo deve ser coletado durante o checkout. collectShippingAddress: type: boolean description: >- Um valor booleano que indica se o endereço de entrega deve ser coletado durante o checkout. createContractOnPurchase: type: boolean description: >- Um booleano que indica se um contrato deve ser criado no momento da compra. currencyCode: type: string description: >- O código da moeda para o link de pagamento, representado como uma string. dealConfigurations: type: object properties: {} description: Um objeto que contém as configurações de um negócio. descriptionHtml: type: object properties: {} description: Um objeto que contém a descrição HTML do link de pagamento. discount: $ref: '#/components/schemas/DiscountRequest' discountCodeEnabled: type: boolean description: >- Um booleano que indica se os códigos de desconto estão ativados para o link de pagamento. discountObjectId: type: object properties: {} description: >- Um objeto que representa o ID do objeto de desconto associado ao link de pagamento. domainId: type: object properties: {} description: >- Um objeto que representa o ID do domínio associado ao link de pagamento. enableDefaultCheckoutFees: type: boolean description: Um booleano indicando se as taxas de checkout padrão estão ativadas. expirationSettings: type: object properties: {} description: >- Um objeto que representa as configurações de expiração do link de pagamento. feeObjectIds: type: array description: >- Uma matriz de strings que representam os IDs de objetos de taxas associados ao link de pagamento. items: type: string fees: type: array description: >- Uma matriz de objetos FeeRequest que representam as taxas associadas ao link de pagamento. items: $ref: '#/components/schemas/FeeRequest' includeEmailInSuccessRedirect: type: boolean description: >- Um valor booleano que indica se o e-mail deve ser incluído no redirecionamento bem-sucedido. isOneTimeUseEnabled: type: boolean description: >- Um booleano que indica se o link de pagamento está ativado para uso único. lineItemObjectIds: type: array description: >- Uma matriz de strings que representam os IDs de objetos de item de linha associados ao link de pagamento. items: type: string lineItems: type: array description: >- Uma matriz de objetos de item de linha, que podem ser dos tipos LineItemCustomCreateRequest, LineItemFromProductCreateRequest ou LineItemCloneCreateRequest. items: oneOf: - $ref: '#/components/schemas/LineItemCustomCreateRequest' - $ref: '#/components/schemas/LineItemFromProductCreateRequest' - $ref: '#/components/schemas/LineItemCloneCreateRequest' paymentLinkName: type: string description: O nome do link de pagamento, representado como uma string. state: type: string description: >- O status do link de pagamento, representado como uma string. Os valores válidos são "ON" e "OFF". enum: - 'OFF' - 'ON' storePaymentMethodAtCheckout: type: boolean description: >- Um booleano que indica se o método de pagamento deve ser armazenado no checkout. successUrl: type: object properties: {} description: >- Um objeto que representa o URL de sucesso para onde o usuário é redirecionado após uma transação bem-sucedida. taxObjectIds: type: array description: >- Uma matriz de strings que representam os IDs de objetos de imposto associados ao link de pagamento. items: type: string taxes: type: array description: >- Uma matriz de objetos TaxRequest que representam os impostos associados ao link de pagamento. items: $ref: '#/components/schemas/TaxRequest' PaymentLinkResponse: required: - acceptedPaymentMethods - additionalFormFields - archived - automatedSalesTaxEnabled - checkoutFeeIds - collectFullBillingAddress - collectShippingAddress - completedPurchaseCount - createContractOnPurchase - currencyCode - discountCodeEnabled - discounts - fees - formGuid - id - includeEmailInSuccessRedirect - isOneTimeUseEnabled - lineItems - paymentLinkName - paymentLinkUrl - state - storePaymentMethodAtCheckout - taxes type: object properties: acceptedPaymentMethods: type: array description: >- Uma matriz de métodos de pagamento aceitos para o link de pagamento. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS" e "PADS". items: type: string enum: - CREDIT_OR_DEBIT_CARD - ACH - SEPA - BACS - PADS - AFFIRM - KLARNA additionalFormFields: type: array description: >- Uma matriz de campos de formulário adicionais incluídos no link de pagamento. items: $ref: '#/components/schemas/PaymentLinkFormField' archived: type: boolean description: Um booleano que indica se o link de pagamento está arquivado. archivedAt: type: string description: >- A data e a hora em que o link de pagamento foi arquivado, no formato ISO 8601. format: date-time automatedSalesTaxEnabled: type: boolean description: >- Um booleano que indica se o imposto de vendas automatizado está ativado para o link de pagamento. businessUnitId: type: string description: >- O ID da unidade de negócio associada ao link de pagamento, representado como uma string. checkoutFeeIds: type: array description: >- Uma matriz de IDs de taxas de checkout associadas ao link de pagamento. items: type: string collectFullBillingAddress: type: boolean description: >- Um booleano que indica se o endereço de cobrança completo deve ser coletado durante o checkout. collectShippingAddress: type: boolean description: >- Um valor booleano que indica se o endereço de entrega deve ser coletado durante o checkout. completedPurchaseCount: type: integer description: >- O número de compras concluídas feitas por meio deste link de pagamento. format: int32 createContractOnPurchase: type: boolean description: >- Um booleano que indica se um contrato deve ser criado no momento da compra. createdAt: type: string description: >- A data e a hora em que o link de pagamento foi criado, no formato ISO 8601. format: date-time currencyCode: type: string description: >- O código da moeda para o link de pagamento, representado como uma string. dealConfigurations: $ref: '#/components/schemas/DealConfigurations' descriptionHtml: type: string description: A descrição HTML do link de pagamento, representada como uma string. discountCodeEnabled: type: boolean description: >- Um booleano que indica se os códigos de desconto estão ativados para o link de pagamento. discounts: type: array description: Uma matriz de objetos de desconto associados ao link de pagamento. items: $ref: '#/components/schemas/DiscountResponse' domainId: type: string description: >- O ID de domínio associado ao link de pagamento, representado como uma string. expirationSettings: $ref: '#/components/schemas/ExpirationSettings' fees: type: array description: Uma matriz de objetos de taxa associados ao link de pagamento. items: $ref: '#/components/schemas/FeeResponse' formGuid: type: string description: >- O GUID do formulário associado ao link de pagamento, representado como uma string. id: type: string description: >- O identificador exclusivo do link de pagamento, representado como uma string. includeEmailInSuccessRedirect: type: boolean description: >- Um booleano que indica se o e-mail deve ser incluído no URL de redirecionamento bem-sucedido. isOneTimeUseEnabled: type: boolean description: >- Um booleano que indica se o link de pagamento está ativado para uso único. lineItems: type: array description: Uma matriz de itens de linha associados ao link de pagamento. items: $ref: '#/components/schemas/LineItem' paymentLinkName: type: string description: O nome do link de pagamento, representado como uma string. paymentLinkUrl: type: string description: O URL do link de pagamento, representado como uma string. state: type: string description: >- O estado atual do link de pagamento, representado como uma string. Os valores válidos incluem "ON" e "OFF". enum: - 'OFF' - 'ON' storePaymentMethodAtCheckout: type: boolean description: >- Um booleano que indica se o método de pagamento deve ser armazenado no checkout. successUrl: type: string description: >- O URL ao qual redirecionar após o pagamento bem-sucedido, representado como uma string. taxes: type: array description: Uma matriz de objetos de impostos associados ao link de pagamento. items: $ref: '#/components/schemas/TaxResponse' updatedAt: type: string description: >- A data e a hora da última atualização do link de pagamento, no formato ISO 8601. format: date-time PaymentLinkFormField: required: - isRequired - label - objectType - options - propertyName type: object properties: description: type: string description: >- Uma descrição do campo do formulário, fornecendo contexto ou instruções adicionais, representada como uma string. isRequired: type: boolean description: >- Um booleano que indica se este campo do formulário é de preenchimento obrigatório. label: type: string description: >- O rótulo do campo do formulário, que é exibido para os usuários, representado como uma string. objectType: type: string description: >- O tipo de objeto ao qual este campo de formulário está associado, representado como uma string. Os valores válidos incluem "CONTACT" e "COMPANY". enum: - COMPANY - CONTACT options: type: array description: >- Uma variedade de opções disponíveis para este campo do formulário, cada uma representada como um objeto FormFieldOption. items: $ref: '#/components/schemas/FormFieldOption' propertyName: type: string description: >- O nome da propriedade associada a este campo do formulário, representado como uma string. DiscountRequest: required: - label - value - valueType type: object properties: label: type: string description: Um rótulo descritivo para o desconto. Este é um texto. value: type: number description: O valor numérico do desconto a ser aplicado. Este é um número. valueType: type: string description: O tipo de valor do desconto, que pode ser "FIXED" ou "PERCENT". enum: - FIXED - PERCENT FeeRequest: required: - label - value - valueType type: object properties: label: type: string description: Um rótulo descritivo para a taxa, representado como uma string. value: type: number description: >- O valor numérico da taxa. Este é um número que representa um valor fixo ou uma porcentagem, dependendo do valueType. valueType: type: string description: >- O tipo do valor da taxa que indica se é um valor fixo ou uma porcentagem. Os valores válidos incluem "FIXED" e "PERCENT". enum: - FIXED - PERCENT LineItemCustomCreateRequest: title: CUSTOM required: - mode - name - pricing - quantity type: object properties: allowBuyerSelectedQuantity: type: boolean description: >- Um booleano que especifica se o comprador pode selecionar a quantidade do item de linha. billingCycleAnchorDate: type: string description: >- Uma string em formato de data que representa a data de referência para o ciclo de cobrança. format: date billingStartDelayDays: type: integer description: >- Um número inteiro que indica o número de dias para atrasar o início da cobrança. format: int32 billingStartDelayMonths: type: integer description: >- Um número inteiro que indica o número de meses para atrasar o início da cobrança. format: int32 buyerSelectedQuantityMax: type: number description: >- Um número que indica a quantidade máxima que o comprador pode selecionar. buyerSelectedQuantityMin: type: number description: >- Um número que indica a quantidade mínima que o comprador pode selecionar. description: type: string description: Uma string que fornece uma descrição do item de linha. discount: type: number description: Um número que representa o desconto aplicado ao item de linha. discountPercentage: type: number description: >- Um número que indica a porcentagem de desconto aplicada ao item de linha. externalId: type: string description: >- Uma string que representa um identificador externo para o item de linha. images: type: string description: >- Uma string contendo URLs ou referências a imagens associadas ao item de linha. isEditablePrice: type: boolean description: Booleano que indica se o preço do item de linha é editável. isOptional: type: boolean description: Um booleano indicando se o item de linha é opcional. lineItemCurrencyCode: type: string description: Uma string que representa o código da moeda para o item de linha. mode: type: string description: >- Uma string que indica o modo do item de linha, definido como "CUSTOM". default: CUSTOM enum: - CUSTOM name: type: string description: Uma string que representa o nome do item de linha. positionOnQuote: type: integer description: >- Um número inteiro que indica a posição do item de linha em um orçamento. format: int32 priceBookId: type: string description: >- Uma string que identifica o catálogo de preços associado ao item de linha. pricing: $ref: '#/components/schemas/PricingFullUpdateRequest' productId: type: string description: Uma string que identifica o produto associado ao item de linha. productType: type: string description: Uma string que indica o tipo de produto para o item de linha. quantity: type: number description: Um número que indica a quantidade do item de linha. recurringBillingEndDate: type: string description: >- Uma string em formato de data que indica a data de término da cobrança recorrente. format: date recurringBillingFrequency: type: string description: >- Uma string que especifica a frequência de cobrança recorrente. Os valores válidos incluem 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY' e '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: Uma string que representa o período de cobrança recorrente. recurringBillingStartDate: type: string description: >- Uma string em formato de data que indica a data de início da cobrança recorrente. format: date richTextDescription: type: string description: Uma string contendo uma descrição de rich text do item de linha. sku: type: string description: >- Uma string que representa a unidade de manutenção de estoque (SKU) do item de linha. taxCategory: type: string description: Uma string que representa a categoria de imposto do item de linha. taxRateGroupId: type: string description: >- O ID do grupo de alíquotas de imposto associado ao item de linha como uma string. variantId: type: string description: Uma string que representa o identificador da variante do produto. 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: >- Um objeto que indica se o comprador pode selecionar a quantidade do produto. billingCycleAnchorDate: type: object properties: {} description: >- Um objeto que representa a data de ancoragem para o ciclo de cobrança. billingStartDelayDays: type: object properties: {} description: >- Um objeto que representa o número de dias para atrasar o início da cobrança. billingStartDelayMonths: type: object properties: {} description: >- Um objeto que representa o número de meses para atrasar o início da cobrança. buyerSelectedQuantityMax: type: object properties: {} description: >- Um objeto que representa a quantidade máxima que o comprador pode selecionar. buyerSelectedQuantityMin: type: object properties: {} description: >- Um objeto que representa a quantidade mínima que o comprador pode selecionar. description: type: object properties: {} description: >- Um objeto que representa a descrição do produto associado ao item de linha. discount: type: object properties: {} description: >- Um objeto que representa qualquer desconto aplicado ao item de linha. discountPercentage: type: object properties: {} description: >- Um objeto que representa a porcentagem de desconto aplicada ao item de linha. externalId: type: object properties: {} description: >- Um objeto que representa um identificador externo para o item de linha. images: type: object properties: {} description: Um objeto que representa as imagens associadas ao produto. isEditablePrice: type: object properties: {} description: Um objeto que indica se o preço do item de linha é editável. isOptional: type: object properties: {} description: Um objeto que indica se o item de linha é opcional. lineItemCurrencyCode: type: object properties: {} description: Um objeto que representa o código da moeda para o item de linha. mode: type: string description: >- Uma string que indica o modo de criação do item de linha. O valor padrão e único válido é 'FROM_PRODUCT'. default: FROM_PRODUCT enum: - FROM_PRODUCT name: type: object properties: {} description: >- Um objeto que representa o nome do produto associado ao item de linha. positionOnQuote: type: object properties: {} description: Um objeto que representa a posição do item de linha no orçamento. priceBookId: type: object properties: {} description: >- Um objeto que representa o ID da lista de preços associado ao produto. pricing: type: object properties: {} description: Um objeto que representa os detalhes de preço do item de linha. productId: type: string description: >- Uma string que representa o identificador exclusivo do produto associado ao item de linha. productType: type: object properties: {} description: Um objeto que representa o tipo de produto para o item de linha. quantity: type: object properties: {} description: >- Um objeto que representa a quantidade do produto a ser incluída no item de linha. recurringBillingEndDate: type: object properties: {} description: >- Um objeto que representa a data final do ciclo de cobrança recorrente. recurringBillingFrequency: type: object properties: {} description: >- Um objeto que representa a frequência de cobrança recorrente para o item de linha. recurringBillingPeriod: type: object properties: {} description: Um objeto que representa o período do ciclo de cobrança recorrente. recurringBillingStartDate: type: object properties: {} description: >- Um objeto que representa a data de início do ciclo de cobrança recorrente. richTextDescription: type: object properties: {} description: >- Um objeto que representa uma descrição de rich text do produto associado ao item de linha. sku: type: object properties: {} description: >- Um objeto que representa a unidade de manutenção de estoque (SKU) do produto. taxCategory: type: object properties: {} description: Um objeto que representa a categoria de imposto do produto. taxRateGroupId: type: object properties: {} description: >- Um objeto que representa o ID do grupo de alíquotas de imposto para o produto. variantId: type: object properties: {} description: Um objeto que representa o ID da variante do produto. 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: >- Um objeto que indica se o comprador pode selecionar a quantidade do item de linha. billingCycleAnchorDate: type: object properties: {} description: >- Um objeto que representa a data de referência para o ciclo de cobrança do item de linha. billingStartDelayDays: type: object properties: {} description: >- Um objeto que representa o número de dias para atrasar o início da cobrança do item de linha. billingStartDelayMonths: type: object properties: {} description: >- Um objeto que representa o número de meses para atrasar o início da cobrança do item de linha. buyerSelectedQuantityMax: type: object properties: {} description: >- Um objeto que representa a quantidade máxima que o comprador pode selecionar para o item de linha. buyerSelectedQuantityMin: type: object properties: {} description: >- Um objeto que representa a quantidade mínima que o comprador pode selecionar para o item de linha. description: type: object properties: {} description: Um objeto que representa a descrição do item de linha. discount: type: object properties: {} description: Um objeto que representa o desconto aplicado ao item de linha. discountPercentage: type: object properties: {} description: >- Um objeto que representa o percentual de desconto aplicado ao item de linha. externalId: type: object properties: {} description: >- Um objeto que representa um identificador externo para o item de linha. images: type: object properties: {} description: Um objeto que representa as imagens associadas ao item de linha. isEditablePrice: type: object properties: {} description: Um objeto que indica se o preço do item de linha é editável. isOptional: type: object properties: {} description: Um objeto que indica se o item de linha é opcional. lineItemCurrencyCode: type: object properties: {} description: Um objeto que representa o código da moeda para o item de linha. mode: type: string description: >- Uma string que indica o modo de criação do item de linha, que é "CLONE" para este componente. default: CLONE enum: - CLONE name: type: object properties: {} description: Um objeto que representa o nome do item de linha. positionOnQuote: type: object properties: {} description: Um objeto que representa a posição do item de linha no orçamento. priceBookId: type: object properties: {} description: >- Um objeto que representa o ID da lista de preços associado ao item de linha. pricing: type: object properties: {} description: Um objeto que representa os detalhes de preço do item de linha. productType: type: object properties: {} description: Um objeto que representa o tipo de produto para o item de linha. quantity: type: object properties: {} description: Um objeto que representa a quantidade do item de linha. recurringBillingEndDate: type: object properties: {} description: >- Um objeto que representa a data final para a cobrança recorrente do item de linha. recurringBillingFrequency: type: object properties: {} description: >- Um objeto que representa a frequência de cobrança recorrente para o item de linha. recurringBillingPeriod: type: object properties: {} description: >- Um objeto que representa o período de cobrança para a cobrança recorrente do item de linha. recurringBillingStartDate: type: object properties: {} description: >- Um objeto que representa a data de início da cobrança recorrente para o item de linha. richTextDescription: type: object properties: {} description: Um objeto que representa a descrição em rich text do item de linha. sku: type: object properties: {} description: >- Um objeto que representa a unidade de manutenção de estoque (SKU) do item de linha. sourceLineItemId: type: string description: >- Uma string que representa o ID do item de linha de origem que está sendo clonado. taxCategory: type: object properties: {} description: Um objeto que representa a categoria de imposto do item de linha. taxRateGroupId: type: object properties: {} description: >- Um objeto que representa o ID do grupo de alíquotas de imposto para o item de linha. variantId: type: object properties: {} description: Um objeto que representa o ID da variante do item de linha. x-hubspot-sub-type-impl: true TaxRequest: required: - label - value - valueType type: object properties: label: type: string description: >- Uma string que fornece um rótulo ou descrição para o imposto, usada para fins de identificação ou exibição. value: type: number description: >- O valor numérico do imposto. Ele representa o valor ou a porcentagem, dependendo do valueType. valueType: type: string description: >- Uma string que indica o tipo de valor do imposto. Os valores válidos são "FIXED" para um valor fixo e "PERCENT" para um imposto em porcentagem. enum: - FIXED - PERCENT DealConfigurations: required: - createNewDealOnPurchase type: object properties: createNewDealOnPurchase: type: boolean description: >- Um booleano que indica se um novo negócio deve ser criado no HubSpot após uma compra. Campo obrigatório. pipelineStageId: type: string description: >- O identificador para a fase do pipeline onde o novo negócio será colocado. Este é um valor de string. DiscountResponse: required: - id type: object properties: archived: type: boolean description: Indica se este desconto foi arquivado. Um valor booleano. archivedAt: type: string description: >- A data e a hora em que este desconto foi arquivado, no formato ISO 8601. format: date-time createdAt: type: string description: >- A data e a hora em que este desconto foi criado, no formato ISO 8601. format: date-time id: type: string description: O identificador exclusivo deste desconto. label: type: string description: Um rótulo descritivo para o desconto. updatedAt: type: string description: >- A data e a hora da última atualização deste desconto, no formato ISO 8601. format: date-time value: type: number description: O valor numérico do desconto. valueType: type: string description: O tipo de valor do desconto, que pode ser "FIXED" ou "PERCENT". enum: - FIXED - PERCENT ExpirationSettings: type: object properties: expirationDate: type: string description: >- A data e hora em que o link de pagamento expirará, no formato ISO 8601. format: date-time maxPurchases: type: integer description: >- O número máximo de compras permitido para este link de pagamento. É um valor inteiro. format: int32 FeeResponse: required: - id type: object properties: archived: type: boolean description: Indica se esta taxa foi arquivada. Um valor booleano. archivedAt: type: string description: A data e a hora em que esta taxa foi arquivada, no formato ISO 8601. format: date-time createdAt: type: string description: A data e a hora em que esta taxa foi criada, no formato ISO 8601. format: date-time id: type: string description: O identificador exclusivo desta taxa. label: type: string description: Um rótulo descritivo para a taxa. updatedAt: type: string description: >- A data e a hora em que esta taxa foi atualizada pela última vez, no formato ISO 8601. format: date-time value: type: number description: O valor monetário da taxa. Um número que representa o valor da taxa. valueType: type: string description: O tipo de valor da taxa, que pode ser "FIXED" ou "PERCENT". enum: - FIXED - PERCENT LineItem: required: - id - name - pricing - quantity type: object properties: acv: type: number description: O valor do contrato anual para o item de linha. allowBuyerSelectedQuantity: type: boolean description: Indica se o comprador pode selecionar a quantidade do item de linha. amount: type: number description: >- O valor total do item de linha, calculado como preço multiplicado pela quantidade. archived: type: boolean description: Indica se o item de linha está arquivado. archivedAt: type: string description: >- A data e a hora em que o item de linha foi arquivado, no formato ISO 8601. format: date-time arr: type: number description: A receita recorrente anual para o item de linha. billingCycleAnchorDate: type: string description: >- A data de referência para o ciclo de cobrança, no formato de data ISO 8601. format: date billingPeriodEndDate: type: string description: >- A data de término do período de cobrança, no formato de data ISO 8601. format: date billingPeriodStartDate: type: string description: >- A data de início do período de cobrança, no formato de data ISO 8601. format: date billingStartDelayDays: type: integer description: O número de dias para atrasar o início da cobrança. format: int32 billingStartDelayMonths: type: integer description: O número de meses para atrasar o início da cobrança. format: int32 billingStartDelayType: type: string description: >- O tipo de atraso para o início da cobrança. Os valores válidos incluem "HS_BILLING_START_DELAY_DAYS", "HS_BILLING_START_DELAY_MONTHS" e "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: >- A quantidade máxima que o comprador pode selecionar para o item de linha. buyerSelectedQuantityMin: type: number description: >- A quantidade mínima que o comprador pode selecionar para o item de linha. createdAt: type: string description: >- A data e a hora em que o item de linha foi criado, no formato ISO 8601. format: date-time description: type: string description: Uma descrição de texto do item de linha. discount: type: number description: O desconto aplicado ao item de linha. discountPercentage: type: number description: O percentual de desconto aplicado ao item de linha. effectiveUnitPrice: type: number description: O preço efetivo por unidade após os descontos. externalId: type: string description: >- Um identificador externo para o item de linha, usado para fins de integração. id: type: string description: O identificador exclusivo do item de linha. images: type: string description: Uma URL ou identificador para imagens associadas ao item de linha. isEditablePrice: type: boolean description: Indica se o preço do item de linha é editável. isOptional: type: boolean description: Indica se o item de linha é opcional. isParent: type: boolean description: Indica se este item de linha é um item de linha pai. lineItemCurrencyCode: type: string description: O código da moeda para o item de linha, seguindo o formato ISO 4217. mrr: type: number description: A receita mensal recorrente para o item de linha. name: type: string description: O nome do item de linha. parentLineItemId: type: string description: O identificador exclusivo do item de linha principal. positionOnQuote: type: integer description: >- A posição do item de linha em um orçamento, representada como um número inteiro. format: int32 postTaxAmount: type: number description: O valor após a aplicação dos impostos. preDiscountAmount: type: number description: O valor antes da aplicação de quaisquer descontos. price: type: number description: O preço de uma única unidade do item de linha. priceBookId: type: string description: O identificador do catálogo de preços associado ao item de linha. pricing: $ref: '#/components/schemas/Pricing' pricingModel: type: string description: >- O modelo de precificação usado para o item de linha. Os valores válidos incluem "FLAT", "GRADUATED", "STAIRSTEP" e "VOLUME". enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME productId: type: string description: O identificador do produto associado ao item de linha. productType: type: string description: O tipo de produto para o item de linha. quantity: type: number description: A quantidade do item de linha, representada como um número. rampKey: type: string description: >- Uma chave usada para identificar o cronograma de aumento gradual para o item de linha. recurringBillingDayOfMonth: type: integer description: O dia do mês em que ocorre a cobrança recorrente. format: int32 recurringBillingEndDate: type: string description: >- A data de término da cobrança recorrente, no formato de data ISO 8601. format: date recurringBillingFrequency: type: string description: >- A frequência de cobrança recorrente para o item de linha. Os valores válidos incluem "ANNUALLY", "BIWEEKLY", "MONTHLY", "PER_FIVE_YEARS", "PER_FOUR_YEARS", "PER_SIX_MONTHS", "PER_THREE_YEARS", "PER_TWO_YEARS", "QUARTERLY" e "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: O número de pagamentos para o ciclo de cobrança recorrente. format: int32 recurringBillingPeriod: type: string description: O período para cobrança recorrente. recurringBillingStartDate: type: string description: >- A data de início da cobrança recorrente, no formato de data ISO 8601. format: date recurringBillingTerms: type: string description: >- Os termos de cobrança recorrente. Os valores válidos incluem "AUTOMATICALLY_RENEW" e "FIXED". enum: - AUTOMATICALLY_RENEW - FIXED richTextDescription: type: string description: Uma descrição formatada em rich text do item de linha. sku: type: string description: >- O identificador da unidade de manutenção de estoque (SKU) para o item de linha. tax: type: number description: O valor do imposto aplicado ao item de linha. taxAmount: type: number description: O valor total do imposto deste item de linha. taxCategory: type: string description: A categoria de imposto aplicável a este item de linha. taxRateGroupId: type: string description: O identificador exclusivo do grupo de alíquotas de imposto. tcv: type: number description: O valor total do contrato para o item de linha. termInMonths: type: integer description: A duração do item de linha em meses. format: int32 tierAmount: type: number description: O valor de categoria aplicável ao item de linha. totalDiscount: type: number description: O valor total do desconto aplicado ao item de linha. updatedAt: type: string description: >- A data e a hora da última atualização do item de linha, no formato ISO 8601. format: date-time variantId: type: string description: O identificador da variante do produto associada ao item de linha. TaxResponse: required: - id type: object properties: archived: type: boolean description: Indica se esta entrada de imposto está arquivada. Um valor booleano. archivedAt: type: string description: >- A data e a hora em que esta entrada de imposto foi arquivada, no formato ISO 8601. format: date-time createdAt: type: string description: >- A data e a hora em que esta entrada de imposto foi criada, no formato ISO 8601. format: date-time id: type: string description: O identificador exclusivo desta entrada de imposto. label: type: string description: Um rótulo descritivo para esta entrada de imposto. updatedAt: type: string description: >- A data e a hora da última atualização desta entrada de imposto, no formato ISO 8601. format: date-time value: type: number description: O valor numérico do imposto. valueType: type: string description: O tipo de valor para o imposto, que pode ser "FIXED" ou "PERCENT". enum: - FIXED - PERCENT Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. 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: >- Uma string que fornece informações adicionais ou contexto sobre a opção do campo do formulário. label: type: string description: >- Uma string que representa o nome de exibição da opção do campo do formulário. value: type: string description: >- Uma string que representa o valor subjacente associado à opção do campo do formulário. PricingFullUpdateRequest: required: - prices - pricingModel type: object properties: prices: type: array description: >- Uma matriz de objetos PriceUpdateEntry, cada um especificando os detalhes do preço, como código da moeda e valor do preço para diferentes quantidades. items: $ref: '#/components/schemas/PriceUpdateEntry' pricingModel: type: string description: >- O modelo usado para determinar os preços. Os valores válidos incluem "FLAT", "GRADUATED", "STAIRSTEP" e "VOLUME". enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME Pricing: required: - prices - pricingModel type: object properties: prices: type: array description: >- Uma matriz de entradas de preço, cada uma detalhando um ponto de preço específico dentro do modelo de precificação. items: $ref: '#/components/schemas/PriceEntry' pricingModel: type: string description: >- O tipo de modelo de precificação aplicado. Os valores válidos incluem "FLAT", "GRADUATED", "STAIRSTEP" e "VOLUME". enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. PriceUpdateEntry: required: - currencyCode - price type: object properties: currencyCode: type: string description: >- O código da moeda em que o preço é especificado, representado como uma string. maxQuantity: type: integer description: >- A quantidade máxima para a qual este preço é aplicável, representada como uma string. format: int32 price: type: object properties: {} description: >- Um objeto que representa os detalhes do preço. A estrutura específica deste objeto não é detalhada na especificação. PriceEntry: required: - currencyCode - price type: object properties: currencyCode: type: string description: O código da moeda para o preço, representado como uma string. maxQuantity: type: integer description: >- A quantidade máxima para a qual este preço é aplicável, representada como uma string. format: int32 price: type: number description: O preço do item, representado como um número. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````