> ## 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. # Create contract > Crie um novo contrato na sua conta HubSpot usando a API de contratos de comércio. Esse endpoint permite especificar diversos detalhes do contrato, incluindo informações de cobrança, itens de linha e métodos de pagamento. A data de vigência e o código da moeda do contrato são obrigatórios, juntamente com outros detalhes essenciais. Após a criação bem-sucedida, essa operação retorna o URL do recurso correspondente ao contrato recém-criado. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/2027-03-beta/commerce-contracts-v2027-03-beta.json POST /commerce/contracts/2027-03-beta/contracts 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: post: tags: - Basic summary: Criar contrato description: >- Crie um novo contrato na sua conta HubSpot usando a API de contratos de comércio. Esse endpoint permite especificar diversos detalhes do contrato, incluindo informações de cobrança, itens de linha e métodos de pagamento. A data de vigência e o código da moeda do contrato são obrigatórios, juntamente com outros detalhes essenciais. Após a criação bem-sucedida, essa operação retorna o URL do recurso correspondente ao contrato recém-criado. operationId: post-/commerce/contracts/2027-03-beta/contracts parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ContractCreateRequest' required: true responses: '201': description: successful operation headers: Location: description: URL of the newly created resource style: simple explode: false schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContractResponse' default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: ContractCreateRequest: required: - automatedTaxesEnabled - billingAddress - billingCompanyId - billingContactId - billingStartDateOverride - contractEffectiveDate - currencyCode - dealId - externalPaymentMethodReferenceId - hubspotBillingEnabled - lineItems - locale - name - netPaymentTerms - ownerId - paymentEnabled - poNumber - sellerCompanyAddress - sellerCompanyDomain - sellerCompanyName - sellerEmail - sellerFirstName - sellerLastName - sellerPhone type: object properties: addressTypesToCollect: type: array description: >- Uma matriz de tipos de endereço a serem coletados, que pode incluir "BILLING_ADDRESS" e "SHIPPING_ADDRESS". items: type: string enum: - BILLING_ADDRESS - SHIPPING_ADDRESS allowedPaymentMethods: type: array description: >- Uma lista de métodos de pagamento permitidos para o contrato, como "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM" e "KLARNA". items: type: string enum: - CREDIT_OR_DEBIT_CARD - ACH - SEPA - BACS - PADS - AFFIRM - KLARNA automatedTaxesEnabled: type: object properties: {} description: >- Um objeto que indica se os impostos automatizados estão habilitados para o contrato. billingAddress: type: object properties: {} description: >- Um objeto que representa o endereço de cobrança associado ao contrato. billingCompanyId: type: object properties: {} description: Um objeto que representa o ID da empresa de cobrança. billingContactId: type: string description: Uma string que representa o ID do contato de cobrança. billingStartDateOverride: type: object properties: {} description: >- Um objeto que representa a substituição da data de início da cobrança. businessUnitId: type: string description: >- Uma string que representa o ID da unidade de negócio associada ao contrato. collectionProcess: type: string description: >- Uma string que indica o processo de cobrança do contrato, que pode ser "MANUAL_PAYMENTS" ou "AUTOMATIC_PAYMENTS". enum: - AUTOMATIC_PAYMENTS - MANUAL_PAYMENTS contractEffectiveDate: type: string description: >- Uma string que representa a data efetiva do contrato, em formato de data. format: date currencyCode: type: string description: Uma string que representa o código da moeda do contrato. customProperties: type: object additionalProperties: type: string description: >- Um objeto que contém propriedades personalizadas para o contrato, com valores de string. dealId: type: object properties: {} description: Um objeto que representa o ID do negócio associado. externalPaymentMethodReferenceId: type: object properties: {} description: >- Um objeto que representa o ID de referência do método de pagamento externo. hubspotBillingEnabled: type: boolean description: >- Booleano que indica se a cobrança da HubSpot está ativada para o contrato. lineItems: type: array description: >- Uma matriz de itens de linha incluídos no contrato, que podem ser personalizados, de um produto ou clonados. items: oneOf: - $ref: '#/components/schemas/LineItemCustomCreateRequest' - $ref: '#/components/schemas/LineItemFromProductCreateRequest' - $ref: '#/components/schemas/LineItemCloneCreateRequest' locale: type: object properties: {} description: >- Um objeto que representa as configurações de localidade para o contrato. name: type: string description: Uma string que representa o nome do contrato. netPaymentTerms: type: object properties: {} description: >- Um objeto que indica os termos de pagamento líquidos para o contrato. ownerId: type: object properties: {} description: Um objeto que representa o ID do proprietário do contrato. paymentEnabled: type: boolean description: >- Um booleano que indica se o pagamento está habilitado para o contrato. poNumber: type: object properties: {} description: >- Um objeto que representa o número do pedido de compra para o contrato. sellerCompanyAddress: type: object properties: {} description: Um objeto que representa o endereço da empresa do vendedor. sellerCompanyDomain: type: object properties: {} description: Um objeto que representa o domínio da empresa do vendedor. sellerCompanyName: type: object properties: {} description: Um objeto que representa o nome da empresa do vendedor. sellerEmail: type: object properties: {} description: Um objeto que representa o endereço de e-mail do vendedor. sellerFirstName: type: object properties: {} description: Um objeto que representa o primeiro nome do vendedor. sellerLastName: type: object properties: {} description: Um objeto que representa o sobrenome do vendedor. sellerPhone: type: object properties: {} description: Um objeto que representa o número de telefone do vendedor. ContractResponse: required: - addressTypesToCollect - allowedPaymentMethods - automatedTaxesEnabled - customProperties - hubspotBillingEnabled - id - lineItems - paymentEnabled - status - storePaymentMethodAtCheckout type: object properties: addressTypesToCollect: type: array description: >- Uma matriz que indica os tipos de endereços a serem coletados. Os valores válidos incluem "BILLING_ADDRESS" e "SHIPPING_ADDRESS". items: type: string enum: - BILLING_ADDRESS - SHIPPING_ADDRESS allTransactionsFeeName: type: string description: Nome da taxa aplicada a todas as transações. allTransactionsFeePercentage: type: number description: A porcentagem da taxa aplicada a todas as transações. allowedPaymentMethods: type: array description: >- Uma matriz de métodos de pagamento permitidos. Os valores válidos incluem "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM" e "KLARNA". items: type: string enum: - CREDIT_OR_DEBIT_CARD - ACH - SEPA - BACS - PADS - AFFIRM - KLARNA annualContractValue: type: number description: O valor anual do contrato. automatedTaxesEnabled: type: boolean description: Indica se os impostos automatizados estão ativados para o contrato. billingAddress: $ref: '#/components/schemas/Address' billingCompanyId: type: string description: >- O identificador exclusivo da empresa de cobrança associada ao contrato. billingContactId: type: string description: >- Identificador exclusivo do contato de cobrança associado ao contrato. billingStartDateOverride: type: string description: >- A data para substituir a data de início da cobrança, no formato ISO 8601. format: date businessUnitId: type: string description: >- O identificador exclusivo da unidade de negócio associada ao contrato. cardFeeName: type: string description: O nome da taxa aplicada às transações com cartão. cardFeePercentage: type: number description: A porcentagem da taxa aplicada a transações com cartão. collectionProcess: type: string description: >- O processo de cobrança de pagamentos. Os valores válidos incluem "MANUAL_PAYMENTS" e "AUTOMATIC_PAYMENTS". enum: - AUTOMATIC_PAYMENTS - MANUAL_PAYMENTS contractEffectiveDate: type: string description: A data em que o contrato entra em vigor, no formato ISO 8601. format: date contractSourceId: type: string description: O identificador exclusivo da origem do contrato. createdAt: type: string description: A data e a hora em que o contrato foi criado, no formato ISO 8601. format: date-time currencyCode: type: string description: >- O código da moeda associado ao contrato, representado como uma string. currentAnnualRecurringRevenue: type: number description: A receita recorrente anual atual do contrato. currentMonthlyRecurringRevenue: type: number description: A receita mensal recorrente atual do contrato. customProperties: type: object additionalProperties: type: string description: Um mapa de nomes de propriedades personalizadas para seus valores. dealId: type: string description: O identificador exclusivo do negócio associado ao contrato. directDebitFeeName: type: string description: O nome da taxa aplicada a transações de débito direto. directDebitFeePercentage: type: number description: A porcentagem da taxa aplicada a transações de débito direto. discountCode: type: string description: O código de desconto aplicado ao contrato. endDate: type: string description: A data de término do contrato, no formato ISO 8601. format: date externalPaymentMethodReferenceId: type: string description: O ID de referência externa para o método de pagamento. hubspotBillingEnabled: type: boolean description: Indica se a cobrança da HubSpot está ativada para o contrato. id: type: string description: O identificador exclusivo do contrato. language: type: string description: O idioma associado ao contrato. lineItems: type: array description: Uma lista de itens de linha incluídos no contrato. items: $ref: '#/components/schemas/LineItem' locale: type: string description: O local associado ao contrato. name: type: string description: O nome do contrato. netPaymentTerms: type: integer description: >- Os termos de pagamento líquidos do contrato, representados como um número inteiro. format: int32 paymentEnabled: type: boolean description: Indica se o pagamento está habilitado para o contrato. paymentMethod: type: string description: O método de pagamento usado no contrato. poNumber: type: string description: O número do pedido de compra associado ao contrato. preTerminationContractValue: type: number description: O valor do contrato antes da rescisão. renewalContractId: type: string description: O identificador exclusivo do contrato de renovação. renewalDate: type: string description: A data em que o contrato será renovado, no formato ISO 8601. format: date sellerCompanyAddress: $ref: '#/components/schemas/Address' sellerCompanyName: type: string description: O nome da empresa do vendedor. sellerEmail: type: string description: O endereço de e-mail do vendedor. sellerFirstName: type: string description: O nome do vendedor. sellerLastName: type: string description: O sobrenome do vendedor. sellerPhoneNumber: type: string description: O número de telefone do vendedor. startDate: type: string description: A data de início do contrato, no formato ISO 8601. format: date status: type: string description: >- O status atual do contrato. Os valores válidos incluem "DRAFT", "ACTIVE", "PAUSED", "COMPLETED" e "TERMINATED". enum: - ACTIVE - COMPLETED - DRAFT - PAUSED - TERMINATED storePaymentMethodAtCheckout: type: boolean description: Indica se o método de pagamento deve ser armazenado no checkout. terminationDate: type: string description: A data de rescisão do contrato, no formato ISO 8601. format: date totalBilledAmount: type: number description: O valor total faturado no contrato. totalBilledAmountPreTax: type: number description: O valor total faturado no contrato antes dos impostos. totalCollectedFees: type: number description: O valor total das taxas cobradas sob o contrato. totalCollectedTaxes: type: number description: O valor total dos impostos recolhidos sob o contrato. totalContractValue: type: number description: O valor total do contrato. totalPaidAmount: type: number description: O valor total pago no contrato. updatedAt: type: string description: >- A data e a hora da última atualização do contrato, no formato ISO 8601. format: date-time 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 Address: type: object properties: address: type: string description: >- O endereço principal. É uma string que representa o detalhe principal da localização. address2: type: string description: >- Uma linha de endereço adicional. Esta é uma string usada para detalhes de localização complementares. city: type: string description: A cidade onde o endereço está localizado. É uma string. country: type: string description: >- O país do endereço. Esta é uma string que indica a nação associada ao endereço. countryCode: type: string description: >- O código que representa o país do endereço. É uma string, geralmente seguindo os padrões internacionais de código de país. state: type: string description: >- O estado ou a região do endereço. Esta é uma string que especifica a subdivisão dentro do país. zip: type: string description: >- O código postal do endereço. É uma string usada para fins de entrega de correspondência. LineItem: required: - id - name - pricing - quantity type: object properties: acv: type: number description: O valor do contrato anual para este item de linha. Um número. allowBuyerSelectedQuantity: type: boolean description: >- Indica se o comprador pode selecionar a quantidade deste item de linha. Um valor booleano. amount: type: number description: >- O valor total para este item de linha, calculado como preço multiplicado pela quantidade. Um número. archived: type: boolean description: Indica se este item de linha está arquivado. Um valor booleano. archivedAt: type: string description: >- A data e a hora em que este item de linha foi arquivado, no formato ISO 8601. format: date-time arr: type: number description: A receita recorrente anual para este item de linha. Um número. 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 atraso em dias antes do início da cobrança. Um número inteiro. format: int32 billingStartDelayMonths: type: integer description: O atraso em meses antes do início da cobrança. Um número inteiro. format: int32 billingStartDelayType: type: string description: >- O tipo de atraso antes do 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 este item de linha. Um número. buyerSelectedQuantityMin: type: number description: >- A quantidade mínima que o comprador pode selecionar para este item de linha. Um número. createdAt: type: string description: >- A data e hora em que este 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 a este item de linha. Um número. discountPercentage: type: number description: A porcentagem de desconto aplicada a este item de linha. Um número. effectiveUnitPrice: type: number description: O preço efetivo por unidade após os descontos. Um número. externalId: type: string description: Um identificador externo para este item de linha. id: type: string description: O identificador exclusivo para este item de linha. images: type: string description: Um URL ou referência a imagens associadas a este item de linha. isEditablePrice: type: boolean description: Indica se o preço deste item de linha é editável. Um valor booleano. isOptional: type: boolean description: Indica se este item de linha é opcional. Um valor booleano. isParent: type: boolean description: Indica se este item de linha é um item principal. Um valor booleano. lineItemCurrencyCode: type: string description: >- O código da moeda para este item de linha, seguindo o formato ISO 4217. mrr: type: number description: A receita mensal recorrente para este item de linha. Um número. name: type: string description: O nome do item de linha. parentLineItemId: type: string description: O identificador exclusivo do item de linha principal, se aplicável. positionOnQuote: type: integer description: A posição deste item de linha em um orçamento. Um número inteiro. format: int32 postTaxAmount: type: number description: O valor total após a aplicação do imposto. Um número. preDiscountAmount: type: number description: O valor antes da aplicação de quaisquer descontos. É um número. price: type: number description: O preço de uma unidade do item de linha. Um número. priceBookId: type: string description: >- O identificador exclusivo para o catálogo de preços associado a este item de linha. pricing: $ref: '#/components/schemas/Pricing' pricingModel: type: string description: >- O modelo de precificação usado para este item de linha. Os valores válidos incluem 'FLAT', 'GRADUATED', 'STAIRSTEP' e 'VOLUME'. enum: - FLAT - GRADUATED - STAIRSTEP - VOLUME productId: type: string description: O identificador exclusivo do produto associado a este item de linha. productType: type: string description: O tipo de produto para este item de linha. quantity: type: number description: A quantidade do item de linha. Um número. rampKey: type: string description: >- Um identificador exclusivo para a progressão de preços associada a este item de linha. recurringBillingDayOfMonth: type: integer description: O dia do mês em que ocorre a cobrança recorrente. Um número inteiro. 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 este 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 cobrança recorrente. Um número inteiro. 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 detalhada do item de linha. sku: type: string description: A unidade de manutenção de estoque (SKU) para este item de linha. tax: type: number description: A alíquota de imposto aplicada a este item de linha. Um número. taxAmount: type: number description: O valor total do imposto para este item de linha. Um número. taxCategory: type: string description: A categoria de imposto deste item de linha. taxRateGroupId: type: string description: >- O identificador exclusivo para o grupo de alíquotas de impostos associado a este item de linha. tcv: type: number description: O valor total do contrato para este item de linha. Um número. termInMonths: type: integer description: O período em meses para este item de linha. Um número inteiro. format: int32 tierAmount: type: number description: O valor para a categoria de preço atual. Um número. totalDiscount: type: number description: O valor total do desconto para este item de linha. Um número. updatedAt: type: string description: >- A data e a hora da última atualização deste item de linha, no formato ISO 8601. format: date-time variantId: type: string description: >- O identificador exclusivo para a variante do produto associada a este item de linha. 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 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 Pricing: required: - prices - pricingModel type: object properties: prices: type: array description: >- Uma matriz de entradas de preço, cada uma especificando um código de moeda e o preço correspondente para o item de linha. items: $ref: '#/components/schemas/PriceEntry' 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 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. 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. PriceEntry: required: - currencyCode - price type: object properties: currencyCode: type: string description: A moeda em que o preço é denominado, representada como uma string. maxQuantity: type: integer description: >- A quantidade máxima para a qual este preço é aplicável, representada como um número inteiro. format: int32 price: type: number description: >- O custo do produto ou serviço na moeda especificada, representado como um número. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````