{ "openapi" : "3.0.1", "info" : { "title" : "Commerce Contracts", "description" : "Basepom for all HubSpot Projects", "version" : "2026-09-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" } ], "tags" : [ { "name" : "Advanced" }, { "name" : "Basic" }, { "name" : "Changes" } ], "paths" : { "/commerce/contracts/2026-09-beta/changes" : { "post" : { "tags" : [ "Advanced" ], "operationId" : "post-/commerce/contracts/2026-09-beta/changes_/commerce/contracts/2026-09-beta/changes", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/changes/preview" : { "post" : { "tags" : [ "Advanced" ], "operationId" : "post-/commerce/contracts/2026-09-beta/changes/preview_/commerce/contracts/2026-09-beta/changes/preview", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangePreviewResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "contracts-read" ] } ] } }, "/commerce/contracts/2026-09-beta/changes/{changeId}" : { "get" : { "tags" : [ "Changes" ], "summary" : "Retrieve change", "description" : "Retrieve details of a specific contract change using its unique identifier. This endpoint is useful for obtaining information about the status and type of a contract change, as well as any associated line item changes. It requires the 'contracts-read' scope for access.", "operationId" : "get-/commerce/contracts/2026-09-beta/changes/{changeId}", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "contracts-read" ] } ] }, "patch" : { "tags" : [ "Changes" ], "summary" : "Update change", "description" : "Update an existing contract change in your HubSpot account. This endpoint allows you to modify the details of a specific change identified by its changeId. The request must include the necessary fields to update the contract change, such as the name and any line item changes.", "operationId" : "patch-/commerce/contracts/2026-09-beta/changes/{changeId}", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeUpdateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/changes/{changeId}/accept" : { "post" : { "tags" : [ "Changes" ], "summary" : "Accept Change", "description" : "Accept a specific change to a commerce contract identified by the changeId. This operation is useful for finalizing proposed changes to contracts, ensuring that the modifications are applied and the contract is updated accordingly.", "operationId" : "post-/commerce/contracts/2026-09-beta/changes/{changeId}/accept", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/changes/{changeId}/cancel" : { "post" : { "tags" : [ "Changes" ], "summary" : "Cancel Change", "description" : "Cancel a specific change request associated with a commerce contract. This operation is useful when you need to revoke a proposed or pending change to a contract. It requires the unique identifier of the change you wish to cancel.", "operationId" : "post-/commerce/contracts/2026-09-beta/changes/{changeId}/cancel", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/contracts" : { "post" : { "tags" : [ "Basic" ], "summary" : "Create contract", "description" : "Create a new contract in your HubSpot account using the CommerceContractsPublicApiService. This endpoint allows you to specify various contract details such as billing information, line items, and payment methods. The contract's effective date, currency, and other required fields must be provided in the request body. Successful creation returns the URL of the newly created resource.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/contracts/{contractId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve contract", "description" : "Retrieve a specific contract using its unique identifier. This endpoint provides detailed information about the contract, including its status, line items, and other relevant properties. It is useful for accessing contract details for review or integration purposes.", "operationId" : "get-/commerce/contracts/2026-09-beta/contracts/{contractId}", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "contracts-read" ] } ] }, "patch" : { "tags" : [ "Basic" ], "summary" : "Update contract", "description" : "Update an existing contract in your HubSpot account using the specified contract ID. This operation allows you to modify details of a contract, such as billing information, payment terms, and other properties. Ensure that the contract ID is valid and that all required fields in the request body are provided.", "operationId" : "patch-/commerce/contracts/2026-09-beta/contracts/{contractId}", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractEditRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/contracts/{contractId}/changes" : { "get" : { "tags" : [ "Changes" ], "summary" : "Retrieve changes", "description" : "Retrieve a list of changes associated with a specific contract in your HubSpot account. This endpoint is useful for tracking modifications made to a contract over time, allowing you to audit changes and understand the history of a contract's amendments.", "operationId" : "get-/commerce/contracts/2026-09-beta/contracts/{contractId}/changes", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangesResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "contracts-read" ] } ] }, "post" : { "tags" : [ "Changes" ], "summary" : "Create Change", "description" : "Create a new change for a specific contract in your HubSpot account. This endpoint allows you to propose modifications to an existing contract, such as adding, updating, or removing line items. The changes can be specified in the request body and are associated with the contract identified by the contractId path parameter.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts/{contractId}/changes", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractChangeResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "deprecated" : true, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/contracts/{contractId}/renewal-quotes" : { "post" : { "tags" : [ "Changes" ], "summary" : "Create renewal quote", "description" : "Generate a renewal quote for a specified contract in your HubSpot account. This endpoint allows you to create a new renewal quote based on the contract identified by the contractId path parameter. The request must include a quoteTemplateId to specify the template for the renewal quote.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts/{contractId}/renewal-quotes", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateRenewalQuoteRequest" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } }, "/commerce/contracts/2026-09-beta/contracts/{contractId}/terminate" : { "post" : { "tags" : [ "Basic" ], "summary" : "Terminate contract", "description" : "Terminate a specific contract in your HubSpot account. This operation requires specifying the contract ID and a termination date. It is useful for ending contracts that are no longer needed or have reached their end of service.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts/{contractId}/terminate", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractTerminateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ContractResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "revenue-contracts-public-api-write" ] } ] } } }, "components" : { "schemas" : { "Address" : { "type" : "object", "properties" : { "address" : { "type" : "string", "description" : "The primary street address. It is a string representing the main location information.", "example" : null }, "address2" : { "type" : "string", "description" : "An additional field for the street address, often used for apartment numbers or secondary address information. It is a string.", "example" : null }, "city" : { "type" : "string", "description" : "The city where the address is located. It is a string.", "example" : null }, "country" : { "type" : "string", "description" : "The country where the address is located. It is a string.", "example" : null }, "countryCode" : { "type" : "string", "description" : "The code representing the country, typically in ISO format. It is a string.", "example" : null }, "state" : { "type" : "string", "description" : "The state or region where the address is located. It is a string.", "example" : null }, "zip" : { "type" : "string", "description" : "The postal code for the address. It is a string.", "example" : null } }, "example" : null }, "ContractChangeCreateRequest" : { "properties" : { }, "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/DirectContractChangeCreateRequest" }, { "$ref" : "#/components/schemas/QuoteContractChangeCreateRequest" } ] }, "ContractChangePreviewResponse" : { "required" : [ "deltaLineItems", "proposedLineItems" ], "type" : "object", "properties" : { "deltaLineItems" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "proposedLineItems" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } } }, "example" : null }, "ContractChangeResponse" : { "required" : [ "contractId", "deltaLineItems", "id", "lineItemChanges", "proposedLineItems", "prorating", "status", "type" ], "type" : "object", "properties" : { "contractId" : { "type" : "string", "description" : "The unique identifier of the contract associated with this change.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this contract change was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "deltaLineItems" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "effectiveDate" : { "type" : "string", "description" : "The date when the contract change becomes effective, in ISO 8601 date format.", "format" : "date", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this contract change.", "example" : null }, "lineItemChanges" : { "type" : "array", "description" : "An array of line item changes associated with this contract change.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItemChangeResponse" } }, "name" : { "type" : "string", "description" : "The name of the contract change.", "example" : null }, "proposedLineItems" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "prorating" : { "type" : "boolean", "description" : "A boolean indicating whether the contract change involves prorating.", "example" : null }, "quoteId" : { "type" : "string", "description" : "The unique identifier of the quote associated with this contract change, if applicable.", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the contract change. Valid values include 'DRAFT', 'PROPOSED', 'ACCEPTED', 'CANCELED', 'FAILED', and 'EXPIRED'.", "example" : null, "enum" : [ "ACCEPTED", "CANCELED", "DRAFT", "EXPIRED", "FAILED", "PROPOSED" ] }, "type" : { "type" : "string", "description" : "The type of contract change, which can be either 'DIRECT' or 'QUOTE'.", "example" : null, "enum" : [ "DIRECT", "QUOTE" ] }, "updatedAt" : { "type" : "string", "description" : "The date and time when this contract change was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null } }, "example" : null }, "ContractChangeSummaryResponse" : { "required" : [ "contractId", "id", "lineItemChanges", "prorating", "status", "type" ], "type" : "object", "properties" : { "contractId" : { "type" : "string", "example" : null }, "createdAt" : { "type" : "string", "format" : "date-time", "example" : null }, "effectiveDate" : { "type" : "string", "format" : "date", "example" : null }, "id" : { "type" : "string", "example" : null }, "lineItemChanges" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItemChangeResponse" } }, "name" : { "type" : "string", "example" : null }, "prorating" : { "type" : "boolean", "example" : null }, "quoteId" : { "type" : "string", "example" : null }, "status" : { "type" : "string", "example" : null, "enum" : [ "ACCEPTED", "CANCELED", "DRAFT", "EXPIRED", "FAILED", "PROPOSED" ] }, "type" : { "type" : "string", "example" : null, "enum" : [ "DIRECT", "QUOTE" ] }, "updatedAt" : { "type" : "string", "format" : "date-time", "example" : null } }, "example" : null }, "ContractChangeUpdateRequest" : { "required" : [ "name" ], "type" : "object", "properties" : { "effectiveDate" : { "type" : "string", "description" : "The date on which the contract change becomes effective, formatted as a date string.", "format" : "date", "example" : null }, "lineItemChanges" : { "type" : "array", "description" : "An array of line item changes associated with the contract change, each represented by a LineItemChangeRequest object.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItemChangeRequest" } }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the contract change.", "example" : null }, "prorating" : { "type" : "boolean", "description" : "A boolean indicating whether the contract change should be prorated.", "example" : null } }, "example" : null }, "ContractChangesResponse" : { "required" : [ "changes" ], "type" : "object", "properties" : { "changes" : { "type" : "array", "description" : "An array of contract change objects, each representing a specific change made to the contract. Each item in the array is a ContractChangeResponse object.", "example" : null, "items" : { "$ref" : "#/components/schemas/ContractChangeSummaryResponse" } } }, "example" : null }, "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" : "An array specifying the types of addresses to collect, with possible values including 'BILLING_ADDRESS' and 'SHIPPING_ADDRESS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "BILLING_ADDRESS", "SHIPPING_ADDRESS" ] } }, "allowedPaymentMethods" : { "type" : "array", "description" : "An array specifying the allowed payment methods, with possible values including 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS" ] } }, "automatedTaxesEnabled" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether automated taxes are enabled for the contract.", "example" : null }, "billingAddress" : { "type" : "object", "properties" : { }, "description" : "An object representing the billing address for the contract.", "example" : null }, "billingCompanyId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the billing company.", "example" : null }, "billingContactId" : { "type" : "string", "description" : "A string representing the ID of the billing contact.", "example" : null }, "billingStartDateOverride" : { "type" : "object", "properties" : { }, "description" : "An object representing an override for the billing start date.", "example" : null }, "businessUnitId" : { "type" : "string", "example" : null }, "collectionProcess" : { "type" : "string", "description" : "A string indicating the collection process for payments, with possible values including 'MANUAL_PAYMENTS' and 'AUTOMATIC_PAYMENTS'.", "example" : null, "enum" : [ "AUTOMATIC_PAYMENTS", "MANUAL_PAYMENTS" ] }, "contractEffectiveDate" : { "type" : "string", "description" : "A string representing the effective date of the contract, in date format.", "format" : "date", "example" : null }, "currencyCode" : { "type" : "string", "description" : "A string representing the currency code for the contract.", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing custom properties for the contract, with each property being a key-value pair.", "example" : null }, "dealId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the associated deal.", "example" : null }, "externalPaymentMethodReferenceId" : { "type" : "object", "properties" : { }, "description" : "An object representing an external reference ID for the payment method.", "example" : null }, "hubspotBillingEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether HubSpot billing is enabled for the contract.", "example" : null }, "lineItems" : { "type" : "array", "description" : "An array of line items included in the contract, which can be custom, from a product, or cloned.", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/LineItemCustomCreateRequest" }, { "$ref" : "#/components/schemas/LineItemFromProductCreateRequest" }, { "$ref" : "#/components/schemas/LineItemCloneCreateRequest" } ] } }, "locale" : { "type" : "object", "properties" : { }, "description" : "An object representing the locale settings for the contract.", "example" : null }, "name" : { "type" : "string", "description" : "A string representing the name of the contract.", "example" : null }, "netPaymentTerms" : { "type" : "object", "properties" : { }, "description" : "An object representing the net payment terms for the contract.", "example" : null }, "ownerId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the contract owner.", "example" : null }, "paymentEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether payment is enabled for the contract.", "example" : null }, "poNumber" : { "type" : "object", "properties" : { }, "description" : "An object representing the purchase order number associated with the contract.", "example" : null }, "sellerCompanyAddress" : { "type" : "object", "properties" : { }, "description" : "An object representing the address of the seller's company.", "example" : null }, "sellerCompanyDomain" : { "type" : "object", "properties" : { }, "description" : "An object representing the domain of the seller's company.", "example" : null }, "sellerCompanyName" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the seller's company.", "example" : null }, "sellerEmail" : { "type" : "object", "properties" : { }, "description" : "An object representing the email address of the seller.", "example" : null }, "sellerFirstName" : { "type" : "object", "properties" : { }, "description" : "An object representing the first name of the seller.", "example" : null }, "sellerLastName" : { "type" : "object", "properties" : { }, "description" : "An object representing the last name of the seller.", "example" : null }, "sellerPhone" : { "type" : "object", "properties" : { }, "description" : "An object representing the phone number of the seller.", "example" : null } }, "example" : null }, "ContractEditRequest" : { "required" : [ "automatedTaxesEnabled", "billingAddress", "billingCompanyId", "billingContactId", "billingStartDateOverride", "dealId", "externalPaymentMethodReferenceId", "locale", "name", "netPaymentTerms", "ownerId", "poNumber", "sellerCompanyAddress", "sellerCompanyDomain", "sellerCompanyName", "sellerEmail", "sellerFirstName", "sellerLastName", "sellerPhone" ], "type" : "object", "properties" : { "addressTypesToCollect" : { "type" : "array", "description" : "An array specifying the types of addresses to collect, with valid values including 'BILLING_ADDRESS' and 'SHIPPING_ADDRESS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "BILLING_ADDRESS", "SHIPPING_ADDRESS" ] } }, "allowedPaymentMethods" : { "type" : "array", "description" : "An array specifying the allowed payment methods, with valid values including 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS" ] } }, "automatedTaxesEnabled" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether automated taxes are enabled for the contract.", "example" : null }, "billingAddress" : { "type" : "object", "properties" : { }, "description" : "An object representing the billing address for the contract.", "example" : null }, "billingCompanyId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the billing company associated with the contract.", "example" : null }, "billingContactId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the billing contact associated with the contract.", "example" : null }, "billingStartDateOverride" : { "type" : "object", "properties" : { }, "description" : "An object representing an override for the billing start date.", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing custom properties, represented as a map of property names to their values.", "example" : null }, "dealId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the deal associated with the contract.", "example" : null }, "externalPaymentMethodReferenceId" : { "type" : "object", "properties" : { }, "description" : "An object representing an external reference ID for the payment method.", "example" : null }, "locale" : { "type" : "object", "properties" : { }, "description" : "An object representing the locale settings for the contract.", "example" : null }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the contract.", "example" : null }, "netPaymentTerms" : { "type" : "object", "properties" : { }, "description" : "An object representing the net payment terms for the contract.", "example" : null }, "ownerId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the owner of the contract.", "example" : null }, "poNumber" : { "type" : "object", "properties" : { }, "description" : "An object representing the purchase order number for the contract.", "example" : null }, "sellerCompanyAddress" : { "type" : "object", "properties" : { }, "description" : "An object representing the address of the seller's company.", "example" : null }, "sellerCompanyDomain" : { "type" : "object", "properties" : { }, "description" : "An object representing the domain of the seller's company.", "example" : null }, "sellerCompanyName" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the seller's company.", "example" : null }, "sellerEmail" : { "type" : "object", "properties" : { }, "description" : "An object representing the email address of the seller.", "example" : null }, "sellerFirstName" : { "type" : "object", "properties" : { }, "description" : "An object representing the first name of the seller.", "example" : null }, "sellerLastName" : { "type" : "object", "properties" : { }, "description" : "An object representing the last name of the seller.", "example" : null }, "sellerPhone" : { "type" : "object", "properties" : { }, "description" : "An object representing the phone number of the seller.", "example" : null } }, "example" : null }, "ContractResponse" : { "required" : [ "addressTypesToCollect", "allowedPaymentMethods", "automatedTaxesEnabled", "customProperties", "hubspotBillingEnabled", "id", "lineItems", "paymentEnabled", "status", "storePaymentMethodAtCheckout" ], "type" : "object", "properties" : { "addressTypesToCollect" : { "type" : "array", "description" : "An array indicating the types of addresses to collect. Valid values include 'BILLING_ADDRESS' and 'SHIPPING_ADDRESS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "BILLING_ADDRESS", "SHIPPING_ADDRESS" ] } }, "allTransactionsFeeName" : { "type" : "string", "description" : "The name of the fee applied to all transactions.", "example" : null }, "allTransactionsFeePercentage" : { "type" : "number", "description" : "The percentage fee applied to all transactions.", "example" : null }, "allowedPaymentMethods" : { "type" : "array", "description" : "An array of allowed payment methods for the contract. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS" ] } }, "annualContractValue" : { "type" : "number", "description" : "The annual value of the contract, represented as a number.", "example" : null }, "automatedTaxesEnabled" : { "type" : "boolean", "description" : "Indicates whether automated taxes are enabled for the contract.", "example" : null }, "billingAddress" : { "$ref" : "#/components/schemas/Address" }, "billingCompanyId" : { "type" : "string", "description" : "The unique identifier for the billing company associated with the contract.", "example" : null }, "billingContactId" : { "type" : "string", "description" : "The unique identifier for the billing contact associated with the contract.", "example" : null }, "billingStartDateOverride" : { "type" : "string", "description" : "An override for the billing start date, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "businessUnitId" : { "type" : "string", "example" : null }, "cardFeeName" : { "type" : "string", "description" : "The name of the fee applied to card transactions.", "example" : null }, "cardFeePercentage" : { "type" : "number", "description" : "The percentage fee applied to card transactions.", "example" : null }, "collectionProcess" : { "type" : "string", "description" : "The process for collecting payments. Valid values include 'MANUAL_PAYMENTS' and 'AUTOMATIC_PAYMENTS'.", "example" : null, "enum" : [ "AUTOMATIC_PAYMENTS", "MANUAL_PAYMENTS" ] }, "contractEffectiveDate" : { "type" : "string", "description" : "The effective date of the contract, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "contractSourceId" : { "type" : "string", "description" : "The unique identifier for the source of the contract.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the contract was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "currencyCode" : { "type" : "string", "description" : "The currency code used for the contract, represented as a string.", "example" : null }, "currentAnnualRecurringRevenue" : { "type" : "number", "description" : "The current annual recurring revenue for the contract, represented as a number.", "example" : null }, "currentMonthlyRecurringRevenue" : { "type" : "number", "description" : "The current monthly recurring revenue for the contract, represented as a number.", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of custom property names to their values for the contract.", "example" : null }, "dealId" : { "type" : "string", "description" : "The unique identifier for the deal associated with the contract.", "example" : null }, "directDebitFeeName" : { "type" : "string", "description" : "The name of the fee applied to direct debit transactions.", "example" : null }, "directDebitFeePercentage" : { "type" : "number", "description" : "The percentage fee applied to direct debit transactions.", "example" : null }, "discountCode" : { "type" : "string", "description" : "The discount code applied to the contract.", "example" : null }, "endDate" : { "type" : "string", "description" : "The end date of the contract, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "externalPaymentMethodReferenceId" : { "type" : "string", "description" : "The external reference ID for the payment method used in the contract.", "example" : null }, "hubspotBillingEnabled" : { "type" : "boolean", "description" : "Indicates whether HubSpot billing is enabled for the contract.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the contract.", "example" : null }, "language" : { "type" : "string", "description" : "The language used for the contract.", "example" : null }, "lineItems" : { "type" : "array", "description" : "An array of line items included in the contract.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "locale" : { "type" : "string", "description" : "The locale setting for the contract.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the contract.", "example" : null }, "netPaymentTerms" : { "type" : "integer", "description" : "The net payment terms for the contract, represented as an integer.", "format" : "int32", "example" : null }, "paymentEnabled" : { "type" : "boolean", "description" : "Indicates whether payment is enabled for the contract.", "example" : null }, "paymentMethod" : { "type" : "string", "description" : "The payment method used for the contract.", "example" : null }, "poNumber" : { "type" : "string", "description" : "The purchase order number associated with the contract.", "example" : null }, "preTerminationContractValue" : { "type" : "number", "description" : "The value of the contract before termination, represented as a number.", "example" : null }, "renewalContractId" : { "type" : "string", "description" : "The unique identifier for the renewal contract.", "example" : null }, "renewalDate" : { "type" : "string", "description" : "The renewal date of the contract, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "sellerCompanyAddress" : { "$ref" : "#/components/schemas/Address" }, "sellerCompanyName" : { "type" : "string", "description" : "The name of the seller's company.", "example" : null }, "sellerEmail" : { "type" : "string", "description" : "The email address of the seller.", "example" : null }, "sellerFirstName" : { "type" : "string", "description" : "The first name of the seller.", "example" : null }, "sellerLastName" : { "type" : "string", "description" : "The last name of the seller.", "example" : null }, "sellerPhoneNumber" : { "type" : "string", "description" : "The phone number of the seller.", "example" : null }, "startDate" : { "type" : "string", "description" : "The start date of the contract, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the contract. Valid values include 'DRAFT', 'ACTIVE', 'PAUSED', 'COMPLETED', and 'TERMINATED'.", "example" : null, "enum" : [ "ACTIVE", "COMPLETED", "DRAFT", "PAUSED", "TERMINATED" ] }, "storePaymentMethodAtCheckout" : { "type" : "boolean", "description" : "Indicates whether the payment method should be stored at checkout.", "example" : null }, "terminationDate" : { "type" : "string", "description" : "The termination date of the contract, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "totalBilledAmount" : { "type" : "number", "description" : "The total amount billed under the contract, represented as a number.", "example" : null }, "totalBilledAmountPreTax" : { "type" : "number", "description" : "The total amount billed under the contract before tax, represented as a number.", "example" : null }, "totalCollectedFees" : { "type" : "number", "description" : "The total fees collected under the contract, represented as a number.", "example" : null }, "totalCollectedTaxes" : { "type" : "number", "description" : "The total taxes collected under the contract, represented as a number.", "example" : null }, "totalContractValue" : { "type" : "number", "description" : "The total value of the contract, represented as a number.", "example" : null }, "totalPaidAmount" : { "type" : "number", "description" : "The total amount paid under the contract, represented as a number.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when the contract was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null } }, "example" : null }, "ContractTerminateRequest" : { "type" : "object", "properties" : { "terminationDate" : { "type" : "string", "description" : "The date on which the contract termination is to take effect. It is represented as a string in date format.", "format" : "date", "example" : null } }, "example" : null }, "CreateRenewalQuoteRequest" : { "required" : [ "quoteTemplateId" ], "type" : "object", "properties" : { "dealId" : { "type" : "string", "description" : "The unique identifier of the deal associated with the renewal quote. It is a string.", "example" : null }, "dealPipeline" : { "type" : "string", "description" : "The pipeline in which the deal associated with the renewal quote resides. It is a string.", "example" : null }, "dealStage" : { "type" : "string", "description" : "The stage of the deal associated with the renewal quote. It is a string.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the renewal quote. It is a string.", "example" : null }, "quoteTemplateId" : { "type" : "string", "description" : "The unique identifier of the template used for the renewal quote. This is a required property and is a string.", "example" : null } }, "example" : null }, "DirectContractChangeCreateRequest" : { "required" : [ "autoAccept", "lineItemChanges", "prorating", "type" ], "type" : "object", "properties" : { "autoAccept" : { "type" : "boolean", "description" : "A boolean indicating whether the contract change should be automatically accepted.", "example" : null }, "contractId" : { "type" : "string", "example" : null }, "effectiveDate" : { "type" : "string", "description" : "The date when the contract change becomes effective, formatted as a date string.", "format" : "date", "example" : null }, "lineItemChanges" : { "type" : "array", "description" : "An array of line item changes to be applied to the contract. Each item in the array is a reference to a LineItemChangeRequest.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItemChangeRequest" } }, "name" : { "type" : "string", "description" : "A string representing the name of the contract change.", "example" : null }, "prorating" : { "type" : "boolean", "description" : "A boolean indicating whether the contract change should be prorated.", "example" : null }, "type" : { "type" : "string", "description" : "A string representing the type of contract change. The default and only valid value is 'DIRECT'.", "example" : null, "default" : "DIRECT", "enum" : [ "DIRECT" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" }, "correlationId" : { "type" : "string", "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "further information about the error", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : "An error occurred" }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "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" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "example" : null }, "LineItem" : { "required" : [ "id", "name", "pricing", "quantity" ], "type" : "object", "properties" : { "acv" : { "type" : "number", "description" : "The annual contract value for the line item. A numeric value.", "example" : null }, "allowBuyerSelectedQuantity" : { "type" : "boolean", "description" : "Indicates whether the buyer can select the quantity of the line item. A boolean value.", "example" : null }, "amount" : { "type" : "number", "description" : "The total amount for the line item, calculated as price multiplied by quantity. A numeric value.", "example" : null }, "archived" : { "type" : "boolean", "description" : "Indicates whether the line item is archived. A boolean value.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when the line item was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "arr" : { "type" : "number", "description" : "The annual recurring revenue for the line item. A numeric value.", "example" : null }, "billingCycleAnchorDate" : { "type" : "string", "description" : "The anchor date for the billing cycle, in ISO 8601 format.", "format" : "date", "example" : null }, "billingPeriodEndDate" : { "type" : "string", "description" : "The end date of the billing period, in ISO 8601 format.", "format" : "date", "example" : null }, "billingPeriodStartDate" : { "type" : "string", "description" : "The start date of the billing period, in ISO 8601 format.", "format" : "date", "example" : null }, "billingStartDelayDays" : { "type" : "integer", "description" : "The number of days to delay the start of billing, represented as an integer.", "format" : "int32", "example" : null }, "billingStartDelayMonths" : { "type" : "integer", "description" : "The number of months to delay the start of billing, represented as an integer.", "format" : "int32", "example" : null }, "billingStartDelayType" : { "type" : "string", "description" : "The type of delay for the start of billing. Valid values include 'HS_BILLING_START_DELAY_DAYS', 'HS_BILLING_START_DELAY_MONTHS', and 'HS_RECURRING_BILLING_START_DATE'.", "example" : null, "enum" : [ "HS_BILLING_START_DELAY_DAYS", "HS_BILLING_START_DELAY_MONTHS", "HS_RECURRING_BILLING_START_DATE" ] }, "buyerSelectedQuantityMax" : { "type" : "number", "description" : "The maximum quantity that a buyer can select for the line item. A numeric value.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "number", "description" : "The minimum quantity that a buyer can select for the line item. A numeric value.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the line item was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "description" : { "type" : "string", "description" : "A text description of the line item.", "example" : null }, "discount" : { "type" : "number", "description" : "The discount applied to the line item. A numeric value.", "example" : null }, "discountPercentage" : { "type" : "number", "description" : "The percentage discount applied to the line item. A numeric value.", "example" : null }, "effectiveUnitPrice" : { "type" : "number", "description" : "The effective price per unit after discounts. A numeric value.", "example" : null }, "externalId" : { "type" : "string", "description" : "An external identifier for the line item, used for integration purposes.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the line item.", "example" : null }, "images" : { "type" : "string", "description" : "A URL or reference to images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "boolean", "description" : "Indicates whether the price of the line item is editable. A boolean value.", "example" : null }, "isOptional" : { "type" : "boolean", "description" : "Indicates whether the line item is optional. A boolean value.", "example" : null }, "isParent" : { "type" : "boolean", "example" : null }, "lineItemCurrencyCode" : { "type" : "string", "description" : "The currency code for the line item, following ISO 4217 format.", "example" : null }, "mrr" : { "type" : "number", "description" : "The monthly recurring revenue for the line item. A numeric value.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the line item.", "example" : null }, "parentLineItemId" : { "type" : "string", "example" : null }, "positionOnQuote" : { "type" : "integer", "description" : "The position of the line item on a quote, represented as an integer.", "format" : "int32", "example" : null }, "postTaxAmount" : { "type" : "number", "description" : "The total amount after taxes are applied. A numeric value.", "example" : null }, "preDiscountAmount" : { "type" : "number", "description" : "The amount before any discounts are applied. A numeric value.", "example" : null }, "price" : { "type" : "number", "description" : "The price of a single unit of the line item. A numeric value.", "example" : null }, "priceBookId" : { "type" : "string", "description" : "The unique identifier for the price book associated with the line item.", "example" : null }, "pricing" : { "$ref" : "#/components/schemas/Pricing" }, "pricingModel" : { "type" : "string", "description" : "The pricing model used for the line item. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.", "example" : null, "enum" : [ "FLAT", "GRADUATED", "STAIRSTEP", "VOLUME" ] }, "productId" : { "type" : "string", "description" : "The unique identifier for the product associated with the line item.", "example" : null }, "productType" : { "type" : "string", "description" : "The type of product associated with the line item.", "example" : null }, "quantity" : { "type" : "number", "description" : "The quantity of the line item. A numeric value.", "example" : null }, "rampKey" : { "type" : "string", "description" : "A unique identifier for the ramp associated with the line item.", "example" : null }, "recurringBillingDayOfMonth" : { "type" : "integer", "description" : "The day of the month on which recurring billing occurs, represented as an integer.", "format" : "int32", "example" : null }, "recurringBillingEndDate" : { "type" : "string", "description" : "The end date for recurring billing, in ISO 8601 format.", "format" : "date", "example" : null }, "recurringBillingFrequency" : { "type" : "string", "description" : "The frequency of recurring billing for the line item. Valid values include 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', and 'WEEKLY'.", "example" : null, "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" : "The number of payments in the recurring billing cycle, represented as an integer.", "format" : "int32", "example" : null }, "recurringBillingPeriod" : { "type" : "string", "description" : "The period for recurring billing.", "example" : null }, "recurringBillingStartDate" : { "type" : "string", "description" : "The start date for recurring billing, in ISO 8601 format.", "format" : "date", "example" : null }, "recurringBillingTerms" : { "type" : "string", "description" : "The terms for recurring billing. Valid values include 'AUTOMATICALLY_RENEW' and 'FIXED'.", "example" : null, "enum" : [ "AUTOMATICALLY_RENEW", "FIXED" ] }, "richTextDescription" : { "type" : "string", "description" : "A rich text description of the line item.", "example" : null }, "sku" : { "type" : "string", "description" : "The stock keeping unit identifier for the line item.", "example" : null }, "tax" : { "type" : "number", "description" : "The tax applied to the line item. A numeric value.", "example" : null }, "taxAmount" : { "type" : "number", "example" : null }, "taxCategory" : { "type" : "string", "example" : null }, "taxRateGroupId" : { "type" : "string", "example" : null }, "tcv" : { "type" : "number", "description" : "The total contract value for the line item. A numeric value.", "example" : null }, "termInMonths" : { "type" : "integer", "description" : "The term of the line item in months, represented as an integer.", "format" : "int32", "example" : null }, "tierAmount" : { "type" : "number", "description" : "The amount associated with a specific pricing tier. A numeric value.", "example" : null }, "totalDiscount" : { "type" : "number", "description" : "The total discount amount applied to the line item. A numeric value.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when the line item was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "variantId" : { "type" : "string", "description" : "The unique identifier for the product variant associated with the line item.", "example" : null } }, "example" : null }, "LineItemChangeRequest" : { "required" : [ "action" ], "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "The action to be performed on the line item. Valid values include 'ADD', 'UPDATE', and 'REMOVE'.", "example" : null, "enum" : [ "ADD", "REMOVE", "UPDATE" ] }, "lineItemAdd" : { "description" : "An object representing the details of the line item to be added. This can be one of several types, such as a custom line item, a line item from a product, or a cloned line item.", "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/LineItemCustomCreateRequest" }, { "$ref" : "#/components/schemas/LineItemFromProductCreateRequest" }, { "$ref" : "#/components/schemas/LineItemCloneCreateRequest" } ] }, "lineItemUpdate" : { "$ref" : "#/components/schemas/LineItemChangeUpdate" }, "rampKey" : { "type" : "string", "description" : "A unique identifier for the ramp associated with the line item, formatted as a UUID.", "format" : "uuid", "example" : null } }, "example" : null }, "LineItemChangeResponse" : { "required" : [ "action", "rampKey" ], "type" : "object", "properties" : { "action" : { "type" : "string", "description" : "The type of action performed on the line item. Valid values include 'ADD', 'UPDATE', and 'REMOVE'.", "example" : null, "enum" : [ "ADD", "REMOVE", "UPDATE" ] }, "lineItemAdd" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/LineItemCustomCreateRequest" }, { "$ref" : "#/components/schemas/LineItemFromProductCreateRequest" }, { "$ref" : "#/components/schemas/LineItemCloneCreateRequest" } ] }, "lineItemUpdate" : { "$ref" : "#/components/schemas/LineItemChangeUpdate" }, "rampKey" : { "type" : "string", "description" : "A unique identifier for the ramp associated with the line item change, formatted as a UUID.", "format" : "uuid", "example" : null } }, "example" : null }, "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" : "An object indicating whether the buyer is allowed to select the quantity of the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the anchor date for the billing cycle of the line item.", "example" : null }, "billingStartDelayDays" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of days to delay the start of billing for the line item.", "example" : null }, "billingStartDelayMonths" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of months to delay the start of billing for the line item.", "example" : null }, "buyerSelectedQuantityMax" : { "type" : "object", "properties" : { }, "description" : "An object representing the maximum quantity that the buyer can select for the line item.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "object", "properties" : { }, "description" : "An object representing the minimum quantity that the buyer can select for the line item.", "example" : null }, "description" : { "type" : "object", "properties" : { }, "description" : "An object representing the description of the line item.", "example" : null }, "discount" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount percentage applied to the line item.", "example" : null }, "externalId" : { "type" : "object", "properties" : { }, "description" : "An object representing the external ID of the line item.", "example" : null }, "images" : { "type" : "object", "properties" : { }, "description" : "An object representing the images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "object", "properties" : { }, "description" : "An object representing the currency code for the line item.", "example" : null }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "object", "properties" : { }, "description" : "An object representing the position of the line item on the quote.", "example" : null }, "priceBookId" : { "type" : "object", "properties" : { }, "description" : "An object representing the price book ID associated with the line item.", "example" : null }, "pricing" : { "type" : "object", "properties" : { }, "description" : "An object representing the pricing details of the line item.", "example" : null }, "productType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of product for the line item.", "example" : null }, "quantity" : { "type" : "object", "properties" : { }, "description" : "An object representing the quantity of the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the end date for recurring billing of the line item.", "example" : null }, "recurringBillingFrequency" : { "type" : "object", "properties" : { }, "description" : "An object representing the frequency of recurring billing for the line item.", "example" : null }, "recurringBillingPeriod" : { "type" : "object", "properties" : { }, "description" : "An object representing the billing period for recurring billing of the line item.", "example" : null }, "recurringBillingStartDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the start date for recurring billing of the line item.", "example" : null }, "richTextDescription" : { "type" : "object", "properties" : { }, "description" : "An object representing the rich text description of the line item.", "example" : null }, "sku" : { "type" : "object", "properties" : { }, "description" : "An object representing the stock keeping unit (SKU) of the line item.", "example" : null }, "taxCategory" : { "type" : "object", "properties" : { }, "description" : "An object representing the tax category of the line item.", "example" : null }, "taxRateGroupId" : { "type" : "object", "properties" : { }, "description" : "An object representing the tax rate group ID for the line item.", "example" : null }, "variantId" : { "type" : "object", "properties" : { }, "description" : "An object representing the variant ID of the line item.", "example" : null } }, "example" : null }, "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" : "An object indicating whether the buyer can select the quantity of the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the anchor date for the billing cycle of the line item.", "example" : null }, "billingStartDelayDays" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of days to delay the start of billing for the line item.", "example" : null }, "billingStartDelayMonths" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of months to delay the start of billing for the line item.", "example" : null }, "buyerSelectedQuantityMax" : { "type" : "object", "properties" : { }, "description" : "An object representing the maximum quantity that the buyer can select for the line item.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "object", "properties" : { }, "description" : "An object representing the minimum quantity that the buyer can select for the line item.", "example" : null }, "description" : { "type" : "object", "properties" : { }, "description" : "An object representing the description of the line item.", "example" : null }, "discount" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "object", "properties" : { }, "description" : "An object representing the percentage discount applied to the line item.", "example" : null }, "externalId" : { "type" : "object", "properties" : { }, "description" : "An object representing an external identifier for the line item.", "example" : null }, "images" : { "type" : "object", "properties" : { }, "description" : "An object representing the images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "object", "properties" : { }, "description" : "An object representing the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string indicating the mode of the line item creation, which is 'CLONE' by default.", "example" : null, "default" : "CLONE", "enum" : [ "CLONE" ] }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "object", "properties" : { }, "description" : "An object representing the position of the line item on the quote.", "example" : null }, "priceBookId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the price book associated with the line item.", "example" : null }, "pricing" : { "type" : "object", "properties" : { }, "description" : "An object representing the pricing details of the line item.", "example" : null }, "productType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of product for the line item.", "example" : null }, "quantity" : { "type" : "object", "properties" : { }, "description" : "An object representing the quantity of the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the end date for recurring billing of the line item.", "example" : null }, "recurringBillingFrequency" : { "type" : "object", "properties" : { }, "description" : "An object representing the frequency of recurring billing for the line item.", "example" : null }, "recurringBillingPeriod" : { "type" : "object", "properties" : { }, "description" : "An object representing the billing period for recurring billing of the line item.", "example" : null }, "recurringBillingStartDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the start date for recurring billing of the line item.", "example" : null }, "richTextDescription" : { "type" : "object", "properties" : { }, "description" : "An object representing the rich text description of the line item.", "example" : null }, "sku" : { "type" : "object", "properties" : { }, "description" : "An object representing the stock keeping unit (SKU) of the line item.", "example" : null }, "sourceLineItemId" : { "type" : "string", "description" : "A string representing the ID of the source line item being cloned.", "example" : null }, "taxCategory" : { "type" : "object", "properties" : { }, "example" : null }, "taxRateGroupId" : { "type" : "object", "properties" : { }, "example" : null }, "variantId" : { "type" : "object", "properties" : { }, "description" : "An object representing the variant ID of the line item.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "LineItemCustomCreateRequest" : { "title" : "CUSTOM", "required" : [ "mode", "name", "pricing", "quantity" ], "type" : "object", "properties" : { "allowBuyerSelectedQuantity" : { "type" : "boolean", "description" : "A boolean specifying if the buyer can select the quantity of the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "string", "description" : "A string in date format representing the anchor date for the billing cycle.", "format" : "date", "example" : null }, "billingStartDelayDays" : { "type" : "integer", "description" : "An integer indicating the number of days to delay the start of billing.", "format" : "int32", "example" : null }, "billingStartDelayMonths" : { "type" : "integer", "description" : "An integer specifying the number of months to delay the start of billing.", "format" : "int32", "example" : null }, "buyerSelectedQuantityMax" : { "type" : "number", "description" : "A number representing the maximum quantity the buyer can select.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "number", "description" : "A number representing the minimum quantity the buyer can select.", "example" : null }, "description" : { "type" : "string", "description" : "A string providing a description of the line item.", "example" : null }, "discount" : { "type" : "number", "description" : "A number representing the discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "number", "description" : "A number indicating the percentage discount applied to the line item.", "example" : null }, "externalId" : { "type" : "string", "description" : "A string containing an external identifier for the line item.", "example" : null }, "images" : { "type" : "string", "description" : "A string containing URLs or references to images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "boolean", "description" : "A boolean indicating if the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "boolean", "description" : "A boolean indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "string", "description" : "A string representing the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string indicating the mode of the line item, with a default value of 'CUSTOM'.", "example" : null, "default" : "CUSTOM", "enum" : [ "CUSTOM" ] }, "name" : { "type" : "string", "description" : "A string representing the name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "integer", "description" : "An integer indicating the position of the line item on a quote.", "format" : "int32", "example" : null }, "priceBookId" : { "type" : "string", "description" : "A string representing the ID of the price book associated with the line item.", "example" : null }, "pricing" : { "$ref" : "#/components/schemas/PricingFullUpdateRequest" }, "productId" : { "type" : "string", "description" : "A string identifying the product associated with the line item.", "example" : null }, "productType" : { "type" : "string", "description" : "A string indicating the type of product for the line item.", "example" : null }, "quantity" : { "type" : "number", "description" : "A number specifying the quantity of the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "string", "description" : "A string in date format indicating the end date of recurring billing.", "format" : "date", "example" : null }, "recurringBillingFrequency" : { "type" : "string", "description" : "A string specifying the frequency of recurring billing for the line item, with valid values including 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', and 'WEEKLY'.", "example" : null, "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" : "A string specifying the period of recurring billing.", "example" : null }, "recurringBillingStartDate" : { "type" : "string", "description" : "A string in date format representing the start date of recurring billing.", "format" : "date", "example" : null }, "richTextDescription" : { "type" : "string", "description" : "A string containing a rich text description of the line item.", "example" : null }, "sku" : { "type" : "string", "description" : "A string representing the stock keeping unit (SKU) of the line item.", "example" : null }, "taxCategory" : { "type" : "string", "example" : null }, "taxRateGroupId" : { "type" : "string", "example" : null }, "variantId" : { "type" : "string", "description" : "A string identifying the variant of the product for the line item.", "example" : null } }, "example" : null, "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" : "An object indicating whether the buyer can select the quantity of the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the anchor date for the billing cycle.", "example" : null }, "billingStartDelayDays" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of days to delay the start of billing.", "example" : null }, "billingStartDelayMonths" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of months to delay the start of billing.", "example" : null }, "buyerSelectedQuantityMax" : { "type" : "object", "properties" : { }, "description" : "An object representing the maximum quantity the buyer can select.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "object", "properties" : { }, "description" : "An object representing the minimum quantity the buyer can select.", "example" : null }, "description" : { "type" : "object", "properties" : { }, "description" : "An object representing the description of the line item.", "example" : null }, "discount" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "object", "properties" : { }, "description" : "An object representing the percentage discount applied to the line item.", "example" : null }, "externalId" : { "type" : "object", "properties" : { }, "description" : "An object representing an external identifier for the line item.", "example" : null }, "images" : { "type" : "object", "properties" : { }, "description" : "An object representing the images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "object", "properties" : { }, "description" : "An object representing the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string indicating the mode of the line item creation, defaulting to 'FROM_PRODUCT'.", "example" : null, "default" : "FROM_PRODUCT", "enum" : [ "FROM_PRODUCT" ] }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "object", "properties" : { }, "description" : "An object representing the position of the line item on the quote.", "example" : null }, "priceBookId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the price book associated with the line item.", "example" : null }, "pricing" : { "type" : "object", "properties" : { }, "description" : "An object representing the pricing details of the line item.", "example" : null }, "productId" : { "type" : "string", "description" : "A string representing the ID of the product associated with the line item.", "example" : null }, "productType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of product for the line item.", "example" : null }, "quantity" : { "type" : "object", "properties" : { }, "description" : "An object representing the quantity of the product in the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the end date for recurring billing.", "example" : null }, "recurringBillingFrequency" : { "type" : "object", "properties" : { }, "description" : "An object representing the frequency of recurring billing for the line item.", "example" : null }, "recurringBillingPeriod" : { "type" : "object", "properties" : { }, "description" : "An object representing the period of recurring billing.", "example" : null }, "recurringBillingStartDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the start date for recurring billing.", "example" : null }, "richTextDescription" : { "type" : "object", "properties" : { }, "description" : "An object representing the rich text description of the line item.", "example" : null }, "sku" : { "type" : "object", "properties" : { }, "description" : "An object representing the stock keeping unit (SKU) of the product.", "example" : null }, "taxCategory" : { "type" : "object", "properties" : { }, "example" : null }, "taxRateGroupId" : { "type" : "object", "properties" : { }, "example" : null }, "variantId" : { "type" : "object", "properties" : { }, "description" : "An object representing the variant ID of the product.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PriceEntry" : { "required" : [ "currencyCode", "price" ], "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The currency code in which the price is denominated, represented as a string.", "example" : null }, "maxQuantity" : { "type" : "integer", "description" : "The maximum quantity applicable for this price entry, represented as a string.", "format" : "int32", "example" : null }, "price" : { "type" : "number", "description" : "The monetary value of the product or service, represented as a number.", "example" : null } }, "example" : null }, "PriceUpdateEntry" : { "required" : [ "currencyCode", "price" ], "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The currency code in which the price is denominated, represented as a string.", "example" : null }, "maxQuantity" : { "type" : "integer", "description" : "The maximum quantity for which this price is applicable, represented as a string.", "format" : "int32", "example" : null }, "price" : { "type" : "object", "properties" : { }, "description" : "The price value associated with the currency code, represented as an object.", "example" : null } }, "example" : null }, "Pricing" : { "required" : [ "prices", "pricingModel" ], "type" : "object", "properties" : { "prices" : { "type" : "array", "description" : "An array of price entries, each detailing the currency and price for the contract or line item.", "example" : null, "items" : { "$ref" : "#/components/schemas/PriceEntry" } }, "pricingModel" : { "type" : "string", "description" : "The pricing model applied to the contract or line item. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.", "example" : null, "enum" : [ "FLAT", "GRADUATED", "STAIRSTEP", "VOLUME" ] } }, "example" : null }, "PricingFullUpdateRequest" : { "required" : [ "prices", "pricingModel" ], "type" : "object", "properties" : { "prices" : { "type" : "array", "description" : "An array of PriceUpdateEntry objects, each representing a price entry with details such as currency code and price.", "example" : null, "items" : { "$ref" : "#/components/schemas/PriceUpdateEntry" } }, "pricingModel" : { "type" : "string", "description" : "A string representing the pricing model used. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.", "example" : null, "enum" : [ "FLAT", "GRADUATED", "STAIRSTEP", "VOLUME" ] } }, "example" : null }, "QuoteContractChangeCreateRequest" : { "required" : [ "prorating", "quoteTemplateId", "type" ], "type" : "object", "properties" : { "contractId" : { "type" : "string", "example" : null }, "dealId" : { "type" : "string", "description" : "A string representing the ID of the deal associated with the contract change.", "example" : null }, "dealPipeline" : { "type" : "string", "description" : "A string representing the pipeline of the deal associated with the contract change.", "example" : null }, "dealStage" : { "type" : "string", "description" : "A string representing the stage of the deal associated with the contract change.", "example" : null }, "effectiveDate" : { "type" : "string", "description" : "A string representing the date when the contract change becomes effective, in 'date' format.", "format" : "date", "example" : null }, "name" : { "type" : "string", "description" : "A string representing the name of the contract change.", "example" : null }, "prorating" : { "type" : "boolean", "description" : "A boolean indicating whether the contract change should be prorated.", "example" : null }, "quoteTemplateId" : { "type" : "string", "description" : "A string that identifies the quote template associated with the contract change.", "example" : null }, "type" : { "type" : "string", "description" : "A string that specifies the type of contract change. The default value is 'QUOTE'.", "example" : null, "default" : "QUOTE", "enum" : [ "QUOTE" ] } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "QuoteResponse" : { "required" : [ "automatedTaxesEnabled", "customProperties", "hubspotBillingEnabled", "id", "lineItems", "paymentEnabled", "showSignatureBox" ], "type" : "object", "properties" : { "archived" : { "type" : "boolean", "description" : "Indicates whether the quote is archived. A boolean value.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when the quote was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "automatedTaxesEnabled" : { "type" : "boolean", "description" : "Indicates whether automated taxes are enabled for the quote. A boolean value.", "example" : null }, "buyerCompanyId" : { "type" : "string", "description" : "The unique identifier of the buyer's company associated with the quote.", "example" : null }, "buyerContactId" : { "type" : "string", "description" : "The unique identifier of the buyer's contact associated with the quote.", "example" : null }, "comments" : { "type" : "string", "description" : "Additional comments or notes associated with the quote.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the quote was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "currencyCode" : { "type" : "string", "description" : "The currency code in which the quote is denominated.", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of custom property names to their values for the quote.", "example" : null }, "dealId" : { "type" : "string", "description" : "The unique identifier of the deal associated with the quote.", "example" : null }, "esignDate" : { "type" : "string", "description" : "The date when the quote was electronically signed, in ISO 8601 format.", "format" : "date", "example" : null }, "esignNumSignersCompleted" : { "type" : "integer", "description" : "The number of signers who have completed signing the quote.", "format" : "int32", "example" : null }, "esignNumSignersRequired" : { "type" : "integer", "description" : "The total number of signers required to sign the quote.", "format" : "int32", "example" : null }, "expirationDate" : { "type" : "string", "description" : "The date when the quote expires, in ISO 8601 format.", "format" : "date", "example" : null }, "feedback" : { "type" : "string", "description" : "Feedback or additional information related to the quote.", "example" : null }, "hubspotBillingEnabled" : { "type" : "boolean", "description" : "Indicates whether HubSpot billing is enabled for the quote. A boolean value.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the quote.", "example" : null }, "language" : { "type" : "string", "description" : "The language in which the quote is presented.", "example" : null }, "lineItems" : { "type" : "array", "description" : "An array of line items included in the quote.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "locale" : { "type" : "string", "description" : "The locale setting for the quote.", "example" : null }, "paymentEnabled" : { "type" : "boolean", "description" : "Indicates whether payment is enabled for the quote. A boolean value.", "example" : null }, "pdfDownloadLink" : { "type" : "string", "description" : "A link to download the quote as a PDF document.", "example" : null }, "quoteAmount" : { "type" : "number", "description" : "The total amount of the quote.", "example" : null }, "quoteNumber" : { "type" : "string", "description" : "The unique number assigned to the quote.", "example" : null }, "senderCompanyAddress" : { "$ref" : "#/components/schemas/Address" }, "senderCompanyDomain" : { "type" : "string", "description" : "The domain of the sender's company associated with the quote.", "example" : null }, "senderCompanyImageUrl" : { "type" : "string", "description" : "The URL of the image representing the sender's company.", "example" : null }, "senderCompanyName" : { "type" : "string", "description" : "The name of the sender's company associated with the quote.", "example" : null }, "senderEmail" : { "type" : "string", "description" : "The email address of the sender associated with the quote.", "example" : null }, "senderFirstname" : { "type" : "string", "description" : "The first name of the sender associated with the quote.", "example" : null }, "senderJobtitle" : { "type" : "string", "description" : "The job title of the sender associated with the quote.", "example" : null }, "senderLastname" : { "type" : "string", "description" : "The last name of the sender associated with the quote.", "example" : null }, "senderPhone" : { "type" : "string", "description" : "The phone number of the sender associated with the quote.", "example" : null }, "showSignatureBox" : { "type" : "boolean", "description" : "Indicates whether the signature box is displayed on the quote. A boolean value.", "example" : null }, "status" : { "type" : "string", "description" : "The current status of the quote.", "example" : null }, "terms" : { "type" : "string", "description" : "The terms and conditions associated with the quote.", "example" : null }, "timezone" : { "type" : "string", "description" : "The timezone setting for the quote.", "example" : null }, "title" : { "type" : "string", "description" : "The title of the quote.", "example" : null }, "type" : { "type" : "string", "description" : "The type of the quote.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when the quote was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null } }, "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "contracts-read" : "", "revenue-contracts-public-api-write" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }