> ## 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 changes > Recupere as alterações associadas a um contrato específico na sua conta HubSpot. Este endpoint permite ver todas as modificações feitas em um contrato, o que pode ser útil para rastrear o histórico e entender a evolução dos termos do contrato. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2027-03-beta/commerce-contracts-v2027-03-beta.json GET /commerce/contracts/2027-03-beta/contracts/{contractId}/changes openapi: 3.0.1 info: title: Commerce Contracts description: Basepom for all HubSpot Projects version: 2027-03-beta 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: Advanced - name: Basic - name: Changes paths: /commerce/contracts/2027-03-beta/contracts/{contractId}/changes: get: tags: - Changes summary: Recuperar alterações description: >- Recupere as alterações associadas a um contrato específico na sua conta HubSpot. Este endpoint permite ver todas as modificações feitas em um contrato, o que pode ser útil para rastrear o histórico e entender a evolução dos termos do contrato. operationId: get-/commerce/contracts/2027-03-beta/contracts/{contractId}/changes parameters: - name: contractId in: path description: >- O identificador exclusivo do contrato para o qual as alterações estão sendo recuperadas. required: true style: simple explode: false schema: type: string responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ContractChangesResponse' default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: ContractChangesResponse: required: - changes type: object properties: changes: type: array description: >- Uma matriz de resumos de alterações de contrato. Cada item na matriz fornece detalhes sobre uma alteração específica feita no contrato, representada pelo esquema ContractChangeSummaryResponse. items: $ref: '#/components/schemas/ContractChangeSummaryResponse' ContractChangeSummaryResponse: required: - contractId - id - lineItemChanges - prorating - status - type type: object properties: contractId: type: string description: O identificador exclusivo do contrato associado a esta alteração. createdAt: type: string description: >- A data e hora em que esta alteração de contrato foi criada, no formato ISO 8601. format: date-time effectiveDate: type: string description: >- A data em que esta alteração de contrato entra em vigor, no formato "AAAA-MM-DD". format: date id: type: string description: O identificador exclusivo para a alteração do contrato. lineItemChanges: type: array description: >- Uma série de alterações feitas nos itens de linha como parte desta alteração de contrato. items: $ref: '#/components/schemas/LineItemChangeResponse' name: type: string description: O nome atribuído a esta alteração de contrato. prorating: type: boolean description: >- Um booleano que indica se a alteração do contrato envolve ajuste proporcional. quoteId: type: string description: >- O identificador exclusivo do orçamento associado a esta alteração, se aplicável. status: type: string description: >- O status atual da alteração do contrato. Os valores válidos incluem "DRAFT", "PROPOSED", "ACCEPTED", "CANCELED", "FAILED" e "EXPIRED". enum: - ACCEPTED - CANCELED - DRAFT - EXPIRED - FAILED - PROPOSED type: type: string description: O tipo de alteração de contrato, que pode ser "DIRECT" ou "QUOTE". enum: - DIRECT - QUOTE updatedAt: type: string description: >- A data e a hora da última atualização desta alteração de contrato, 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 de erro, fornecido como um objeto com propriedades adicionais que são matrizes de strings. example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- O identificador exclusivo da solicitação. Inclua este valor em relatórios de erro ou tickets de suporte. Ele é formatado como um UUID. format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: >- Mais informações sobre o erro, representadas como uma matriz de objetos ErrorDetail. 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 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 detalhes mais específicos sobre o erro. Esta é uma propriedade de string. 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 LineItemChangeResponse: required: - action - rampKey type: object properties: action: type: string description: >- O tipo de ação realizada no item de linha. Os valores válidos incluem 'ADD', 'UPDATE' e 'REMOVE'. enum: - ADD - ADD_PHASE - PAUSE - REMOVE - REMOVE_PHASE - RESUME - UPDATE - UPDATE_PHASE lineItemAdd: description: >- Um objeto que representa os detalhes do item de linha adicionado se a ação foi "ADD". Pode ser de vários tipos, como personalizado, de um produto ou um clone. oneOf: - $ref: '#/components/schemas/LineItemCustomCreateRequest' - $ref: '#/components/schemas/LineItemFromProductCreateRequest' - $ref: '#/components/schemas/LineItemCloneCreateRequest' lineItemUpdate: $ref: '#/components/schemas/LineItemChangeUpdate' rampKey: type: string description: >- Um identificador exclusivo para a alteração do item de linha, formatado como um UUID. format: uuid ErrorDetail: required: - message type: object properties: code: type: string description: >- O código de status associado ao detalhe do erro, representado como uma string. context: type: object additionalProperties: type: array items: type: string description: >- Contexto sobre a condição de erro, representado como um objeto em que cada chave é uma string e cada valor é uma matriz de strings. Isso fornece informações adicionais sobre o erro. example: '{missingScopes=[scope1, scope2]}' in: type: string description: >- O nome do campo ou parâmetro em que o erro foi encontrado. Este é um campo de string opcional. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado. Este é um campo obrigatório e é do tipo string. subCategory: type: string description: >- Uma categoria específica que contém detalhes mais específicos sobre o erro, fornecida como uma string. 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. LineItemCustomCreateRequest: title: CUSTOM required: - mode - name - pricing - quantity type: object properties: allowBuyerSelectedQuantity: type: boolean description: >- Um booleano que indica 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 atraso em dias antes do início da cobrança. format: int32 billingStartDelayMonths: type: integer description: >- Um número inteiro que representa o atraso em meses antes do início da cobrança. format: int32 buyerSelectedQuantityMax: type: number description: >- Um número que representa 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 valor do 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 que contém URLs de imagem associados 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 especifica o código da moeda para o item de linha. mode: type: string description: >- Uma string que indica o modo do item de linha, que é "CUSTOM" por padrão. 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 no orçamento. format: int32 priceBookId: type: string description: >- Uma string que indica o ID do catálogo de preços associado ao item de linha. pricing: $ref: '#/components/schemas/PricingFullUpdateRequest' productId: type: string description: >- Uma string que representa o ID do 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 representa a data de término da cobrança recorrente. format: date recurringBillingFrequency: type: string description: >- Uma string que representa a frequência da cobrança recorrente, com valores válidos incluindo 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', '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 indica 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 para o item de linha. taxRateGroupId: type: string description: >- Uma string que indica o ID do grupo de alíquotas de imposto aplicável ao item de linha. variantId: type: string description: Uma string que representa o ID 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 item de linha. 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 atraso em dias antes do início da cobrança. billingStartDelayMonths: type: object properties: {} description: >- Um objeto que representa o atraso em meses antes do 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 fornece uma 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 contém 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 indicando 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, com um valor padrão de "FROM_PRODUCT". default: FROM_PRODUCT enum: - FROM_PRODUCT name: type: object properties: {} description: Um objeto que representa o nome do item de linha. positionOnQuote: type: object properties: {} description: Um objeto que indica 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. productId: type: string description: >- Uma string que representa o ID 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 para o item de linha. recurringBillingEndDate: type: object properties: {} description: Um objeto que representa a data final da 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 de cobrança recorrente. recurringBillingStartDate: type: object properties: {} description: Um objeto que representa a data de início da cobrança recorrente. richTextDescription: type: object properties: {} description: Um objeto que fornece uma 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 produto. 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 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. 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 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 do item de linha, com um valor padrão de "CLONE". 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 recorrente para o 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 LineItemChangeUpdate: required: - allowBuyerSelectedQuantity - billingCycleAnchorDate - billingStartDelayDays - billingStartDelayMonths - buyerSelectedQuantityMax - buyerSelectedQuantityMin - description - discount - discountPercentage - externalId - images - isEditablePrice - isOptional - lineItemCurrencyCode - name - positionOnQuote - priceBookId - pricing - 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 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 um comprador pode selecionar para o item de linha. buyerSelectedQuantityMin: type: object properties: {} description: >- Um objeto que representa a quantidade mínima que um 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 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 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. 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. taxCategory: type: object properties: {} description: Um objeto que representa a categoria fiscal do item de linha. taxRateGroupId: type: object properties: {} description: >- Um objeto que representa o ID do grupo de alíquotas de impostos para o item de linha. variantId: type: object properties: {} description: Um objeto que representa o ID da variante do item de linha. PricingFullUpdateRequest: required: - prices - pricingModel type: object properties: prices: type: array description: >- Uma matriz de entradas de preço que definem os detalhes específicos de precificação para o contrato. Cada entrada inclui informações de moeda e preço. items: $ref: '#/components/schemas/PriceUpdateEntry' pricingModel: type: string description: >- O modelo de precificação aplicado ao contrato. Os valores válidos incluem 'FLAT', 'GRADUATED', 'STAIRSTEP' e 'VOLUME'. enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME PriceUpdateEntry: required: - currencyCode - price type: object properties: currencyCode: type: string description: Uma string que representa a moeda na qual o preço é especificado. maxQuantity: type: integer description: >- Um número inteiro que indica a quantidade máxima aplicável para esta entrada de preço. format: int32 price: type: object properties: {} description: Um objeto que representa os detalhes de preço da entrada. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````