> ## 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. # Retrieve payment links > Recupere uma lista de links de pagamento da sua conta HubSpot. Este endpoint permite filtrar e classificar links de pagamento com base em vários critérios, como data/hora de criação e atualização. Ele oferece suporte à paginação e pode incluir links de pagamento arquivados, se especificado. > **Supported products** > **Required Scopes** ## 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: Recuperar todos os links de pagamento description: >- Recupere uma lista de links de pagamento da sua conta HubSpot. Este endpoint permite filtrar e classificar links de pagamento com base em vários critérios, como data/hora de criação e atualização. Ele oferece suporte à paginação e pode incluir links de pagamento arquivados, se especificado. operationId: get-/commerce/payment-links/2026-09/payment-links parameters: - name: after in: query description: >- O token do cursor de paginação do último recurso lido será retornado como a propriedade JSON `paging.next.after` de uma resposta paginada que contém mais resultados. required: false style: form explode: true schema: type: string - name: archived in: query description: Se apenas os resultados que foram arquivados devem ser retornados. required: false style: form explode: true schema: type: boolean default: false - name: createdAfter in: query description: >- Filtre os resultados para incluir apenas aqueles criados após a data/hora especificada. required: false style: form explode: true schema: type: integer format: int64 - name: createdAt in: query description: Filtre os resultados pela data e hora exatas de criação. required: false style: form explode: true schema: type: integer format: int64 - name: createdBefore in: query description: >- Filtre os resultados para incluir apenas aqueles criados antes da data/hora especificada. required: false style: form explode: true schema: type: integer format: int64 - name: limit in: query description: O número máximo de resultados a serem exibidos por página. required: false style: form explode: true schema: type: integer format: int32 default: 20 - name: sort in: query description: Especifica a ordem em que os resultados são retornados. required: false style: form explode: true schema: type: string - name: updatedAfter in: query description: >- Filtre os resultados para incluir apenas aqueles atualizados após a data/hora especificada. required: false style: form explode: true schema: type: integer format: int64 - name: updatedAt in: query description: Filtre os resultados pela data e hora exatas da atualização. required: false style: form explode: true schema: type: integer format: int64 - name: updatedBefore in: query description: >- Filtre os resultados para incluir apenas aqueles atualizados antes do carimbo de data/hora especificado. 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: [] components: schemas: CollectionResponsePaymentLinkResponseForwardPaging: required: - results type: object properties: paging: $ref: '#/components/schemas/ForwardPaging' results: type: array description: >- Uma matriz de objetos PaymentLinkResponse, cada um representando um link de pagamento com seus detalhes associados. items: $ref: '#/components/schemas/PaymentLinkResponse' ForwardPaging: type: object properties: next: $ref: '#/components/schemas/NextPage' description: >- Informações de paginação para paginação somente para frente. Contém a referência da próxima página quando há mais resultados disponíveis; é omitida ou fica vazia na última página. 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 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 NextPage: required: - after type: object properties: after: type: string description: >- Um token de string que indica a posição após o último item na página atual, usado para buscar a próxima página de resultados. link: type: string description: >- Um URL de string que fornece um link direto para a próxima 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: >- 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. 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 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. 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. 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 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' ````