Retrieve contract
Recupere os detalhes de um contrato específico usando seu identificador exclusivo. Este endpoint permite acessar informações abrangentes sobre um contrato, incluindo seu status, itens de linha associados e outros detalhes relevantes. É útil para revisar especificações de contratos ou integrar dados de contratos em outros sistemas.
Supported products
Supported products
Required Scopes
Required Scopes
Parâmetros de caminho
O identificador exclusivo do contrato a ser recuperado.
Resposta
successful operation
Uma matriz que indica os tipos de endereços a serem coletados. Os valores válidos incluem "BILLING_ADDRESS" e "SHIPPING_ADDRESS".
BILLING_ADDRESS, SHIPPING_ADDRESS Uma matriz de métodos de pagamento permitidos. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM" e "KLARNA".
CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA Indica se os impostos automatizados estão ativados para o contrato.
Um mapa de nomes de propriedades personalizadas para seus valores.
Indica se a cobrança da HubSpot está ativada para o contrato.
O identificador exclusivo do contrato.
Uma lista de itens de linha incluídos no contrato.
Indica se o pagamento está habilitado para o contrato.
O status atual do contrato. Os valores válidos incluem "DRAFT", "ACTIVE", "PAUSED", "COMPLETED" e "TERMINATED".
ACTIVE, COMPLETED, DRAFT, PAUSED, TERMINATED Indica se o método de pagamento deve ser armazenado no checkout.
Nome da taxa aplicada a todas as transações.
A porcentagem da taxa aplicada a todas as transações.
O valor anual do contrato.
O identificador exclusivo da empresa de cobrança associada ao contrato.
Identificador exclusivo do contato de cobrança associado ao contrato.
A data para substituir a data de início da cobrança, no formato ISO 8601.
O identificador exclusivo da unidade de negócio associada ao contrato.
O nome da taxa aplicada às transações com cartão.
A porcentagem da taxa aplicada a transações com cartão.
O processo de cobrança de pagamentos. Os valores válidos incluem "MANUAL_PAYMENTS" e "AUTOMATIC_PAYMENTS".
AUTOMATIC_PAYMENTS, MANUAL_PAYMENTS A data em que o contrato entra em vigor, no formato ISO 8601.
O identificador exclusivo da origem do contrato.
A data e a hora em que o contrato foi criado, no formato ISO 8601.
O código da moeda associado ao contrato, representado como uma string.
A receita recorrente anual atual do contrato.
A receita mensal recorrente atual do contrato.
O identificador exclusivo do negócio associado ao contrato.
O nome da taxa aplicada a transações de débito direto.
A porcentagem da taxa aplicada a transações de débito direto.
O código de desconto aplicado ao contrato.
A data de término do contrato, no formato ISO 8601.
O ID de referência externa para o método de pagamento.
O idioma associado ao contrato.
O local associado ao contrato.
O nome do contrato.
Os termos de pagamento líquidos do contrato, representados como um número inteiro.
O método de pagamento usado no contrato.
O número do pedido de compra associado ao contrato.
O valor do contrato antes da rescisão.
O identificador exclusivo do contrato de renovação.
A data em que o contrato será renovado, no formato ISO 8601.
O nome da empresa do vendedor.
O endereço de e-mail do vendedor.
O nome do vendedor.
O sobrenome do vendedor.
O número de telefone do vendedor.
A data de início do contrato, no formato ISO 8601.
A data de rescisão do contrato, no formato ISO 8601.
O valor total faturado no contrato.
O valor total faturado no contrato antes dos impostos.
O valor total das taxas cobradas sob o contrato.
O valor total dos impostos recolhidos sob o contrato.
O valor total do contrato.
O valor total pago no contrato.
A data e a hora da última atualização do contrato, no formato ISO 8601.