{ "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" ], "summary" : "Create Change", "description" : "Create a new change for a commerce contract in your HubSpot account. This endpoint allows you to submit a request to modify existing contracts by specifying the desired changes in the request body. Upon successful creation, the URL of the newly created resource is returned in the response.", "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" ], "summary" : "Preview Changes", "description" : "Preview the changes to a commerce contract before they are applied. This endpoint allows you to simulate contract modifications, providing a preview of the resulting changes without committing them. It is useful for assessing the impact of proposed changes on a contract.", "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 allows you to access information about the change, including its status, type, and any associated line item changes. It is useful for tracking the progress and details of contract modifications.", "operationId" : "get-/commerce/contracts/2026-09-beta/changes/{changeId}", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "The unique identifier of the contract change to retrieve.", "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 details of a specific change identified by its changeId. Use this to adjust contract changes as needed before they are finalized.", "operationId" : "patch-/commerce/contracts/2026-09-beta/changes/{changeId}", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "The unique identifier of the contract change to update.", "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 contract change in the HubSpot commerce system. This endpoint is used to finalize and apply changes to a contract that have been proposed. It requires the unique identifier of the change to be accepted.", "operationId" : "post-/commerce/contracts/2026-09-beta/changes/{changeId}/accept", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "The unique identifier of the contract change to accept.", "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 contract change in your HubSpot account. This operation is useful when you need to revoke a proposed or pending change to a contract. Once canceled, the change will no longer be processed.", "operationId" : "post-/commerce/contracts/2026-09-beta/changes/{changeId}/cancel", "parameters" : [ { "name" : "changeId", "in" : "path", "description" : "The unique identifier of the contract change to cancel.", "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 Commerce Contracts API. This endpoint allows you to specify various contract details, including billing information, line items, and payment methods. The contract's effective date and currency code are required, along with other essential details. This operation returns the URL of the newly created contract resource upon successful creation.", "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 the details of a specific contract using its unique identifier. This endpoint allows you to access comprehensive information about a contract, including its status, associated line items, and other relevant details. It is useful for reviewing contract specifics or integrating contract data into other systems.", "operationId" : "get-/commerce/contracts/2026-09-beta/contracts/{contractId}", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "The unique identifier of the contract to retrieve.", "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 its properties and associated line items. Ensure that the contract ID is valid and corresponds to an existing contract.", "operationId" : "patch-/commerce/contracts/2026-09-beta/contracts/{contractId}", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "The unique identifier of the contract to update.", "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 the changes associated with a specific contract in your HubSpot account. This endpoint allows you to view all modifications made to a contract, which can be useful for tracking contract history and understanding the evolution of contract terms.", "operationId" : "get-/commerce/contracts/2026-09-beta/contracts/{contractId}/changes", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "The unique identifier of the contract for which changes are being retrieved.", "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 contract change", "description" : "Create a change for a specific contract in your HubSpot account. This endpoint allows you to propose modifications to the contract, such as adding, updating, or removing line items. The request body must include the necessary details for the contract change, and upon successful creation, a URL to the newly created resource will be returned.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts/{contractId}/changes", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "The unique identifier of the contract for which the change is being created.", "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" : "Create a new renewal quote for a specific contract in your HubSpot account. This endpoint allows you to generate a renewal quote by specifying the contract ID and necessary details within the request body. The operation is useful for managing contract renewals and ensuring continuity in service agreements.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts/{contractId}/renewal-quotes", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "The unique identifier of the contract for which the renewal quote is being created.", "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 can be used to end a contract as of a specified termination date. Ensure that the contract ID is valid and that you have the necessary permissions to perform this action.", "operationId" : "post-/commerce/contracts/2026-09-beta/contracts/{contractId}/terminate", "parameters" : [ { "name" : "contractId", "in" : "path", "description" : "The unique identifier of the contract to terminate.", "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 detail.", "example" : null }, "address2" : { "type" : "string", "description" : "An additional street address line. This is a string used for supplementary location details.", "example" : null }, "city" : { "type" : "string", "description" : "The city where the address is located. It is represented as a string.", "example" : null }, "country" : { "type" : "string", "description" : "The country of the address. This is a string indicating the nation associated with the address.", "example" : null }, "countryCode" : { "type" : "string", "description" : "The code representing the country of the address. It is a string, typically following international country code standards.", "example" : null }, "state" : { "type" : "string", "description" : "The state or region of the address. This is a string that specifies the subdivision within the country.", "example" : null }, "zip" : { "type" : "string", "description" : "The postal code for the address. It is a string used for mail delivery purposes.", "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", "description" : "An array of LineItem objects representing the changes in line items compared to the current state of the contract.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "proposedLineItems" : { "type" : "array", "description" : "An array of LineItem objects representing the proposed state of line items after the changes are applied.", "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 the contract change was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "deltaLineItems" : { "type" : "array", "description" : "An array of line items that represent the difference resulting from the contract change.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "effectiveDate" : { "type" : "string", "description" : "The date when the contract change becomes effective, in YYYY-MM-DD format.", "format" : "date", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the contract change.", "example" : null }, "lineItemChanges" : { "type" : "array", "description" : "An array of changes to line items associated with the contract change.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItemChangeResponse" } }, "name" : { "type" : "string", "description" : "The name of the contract change.", "example" : null }, "proposedLineItems" : { "type" : "array", "description" : "An array of line items that are proposed as part of the contract change.", "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.", "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. Valid values include 'DIRECT' and 'QUOTE'.", "example" : null, "enum" : [ "DIRECT", "QUOTE" ] }, "updatedAt" : { "type" : "string", "description" : "The date and time when the 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", "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 }, "effectiveDate" : { "type" : "string", "description" : "The date on which this contract change becomes effective, in the format 'YYYY-MM-DD'.", "format" : "date", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this contract change.", "example" : null }, "lineItemChanges" : { "type" : "array", "description" : "An array of changes made to line items as part of this contract change.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItemChangeResponse" } }, "name" : { "type" : "string", "description" : "The name assigned to this contract change.", "example" : null }, "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 }, "ContractChangeUpdateRequest" : { "required" : [ "name" ], "type" : "object", "properties" : { "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 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 summaries. Each item in the array provides details about a specific change made to the contract, represented by the ContractChangeSummaryResponse schema.", "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 of address types to collect, which can include 'BILLING_ADDRESS' and 'SHIPPING_ADDRESS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "BILLING_ADDRESS", "SHIPPING_ADDRESS" ] } }, "allowedPaymentMethods" : { "type" : "array", "description" : "An array of allowed payment methods for the contract, such as 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', 'PADS', 'AFFIRM', and 'KLARNA'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM", "KLARNA" ] } }, "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", "description" : "A string representing the ID of the business unit associated with the contract.", "example" : null }, "collectionProcess" : { "type" : "string", "description" : "A string indicating the collection process for the contract, which can be 'MANUAL_PAYMENTS' or '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 string values.", "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 the external payment method reference ID.", "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 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 }, "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 of strings indicating the types of addresses to collect, such as 'BILLING_ADDRESS' or 'SHIPPING_ADDRESS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "BILLING_ADDRESS", "SHIPPING_ADDRESS" ] } }, "allowedPaymentMethods" : { "type" : "array", "description" : "An array of strings specifying the allowed payment methods, which can include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', 'PADS', 'AFFIRM', and 'KLARNA'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM", "KLARNA" ] } }, "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 the override for the billing start date.", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing a map of custom property names to their values, represented as strings.", "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 the 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 of the fee applied to all transactions.", "example" : null }, "allowedPaymentMethods" : { "type" : "array", "description" : "An array of allowed payment methods. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', 'PADS', 'AFFIRM', and 'KLARNA'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS", "AFFIRM", "KLARNA" ] } }, "annualContractValue" : { "type" : "number", "description" : "The annual value of the contract.", "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 of the billing company associated with the contract.", "example" : null }, "billingContactId" : { "type" : "string", "description" : "The unique identifier of the billing contact associated with the contract.", "example" : null }, "billingStartDateOverride" : { "type" : "string", "description" : "The date to override the billing start date, in ISO 8601 format.", "format" : "date", "example" : null }, "businessUnitId" : { "type" : "string", "description" : "The unique identifier of the business unit associated with the contract.", "example" : null }, "cardFeeName" : { "type" : "string", "description" : "The name of the fee applied to card transactions.", "example" : null }, "cardFeePercentage" : { "type" : "number", "description" : "The percentage of the 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 date when the contract becomes effective, in ISO 8601 format.", "format" : "date", "example" : null }, "contractSourceId" : { "type" : "string", "description" : "The unique identifier of 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 associated with the contract, represented as a string.", "example" : null }, "currentAnnualRecurringRevenue" : { "type" : "number", "description" : "The current annual recurring revenue for the contract.", "example" : null }, "currentMonthlyRecurringRevenue" : { "type" : "number", "description" : "The current monthly recurring revenue for the contract.", "example" : null }, "customProperties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of custom property names to their values.", "example" : null }, "dealId" : { "type" : "string", "description" : "The unique identifier of 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 of the 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 ISO 8601 format.", "format" : "date", "example" : null }, "externalPaymentMethodReferenceId" : { "type" : "string", "description" : "The external reference ID for the payment method.", "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 associated with 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 associated with 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.", "example" : null }, "renewalContractId" : { "type" : "string", "description" : "The unique identifier of the renewal contract.", "example" : null }, "renewalDate" : { "type" : "string", "description" : "The date when the contract is set to renew, in ISO 8601 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 ISO 8601 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 date when the contract is terminated, in ISO 8601 format.", "format" : "date", "example" : null }, "totalBilledAmount" : { "type" : "number", "description" : "The total amount billed under the contract.", "example" : null }, "totalBilledAmountPreTax" : { "type" : "number", "description" : "The total amount billed under the contract before tax.", "example" : null }, "totalCollectedFees" : { "type" : "number", "description" : "The total amount of fees collected under the contract.", "example" : null }, "totalCollectedTaxes" : { "type" : "number", "description" : "The total amount of taxes collected under the contract.", "example" : null }, "totalContractValue" : { "type" : "number", "description" : "The total value of the contract.", "example" : null }, "totalPaidAmount" : { "type" : "number", "description" : "The total amount paid under the contract.", "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 the 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 identifier of the pipeline in which the deal is located. It is a string.", "example" : null }, "dealStage" : { "type" : "string", "description" : "The identifier of the stage within the pipeline that the deal is currently in. 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 quote template to be used for creating the renewal quote. It is a required 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", "description" : "A string that uniquely identifies the contract to which the change applies.", "example" : null }, "effectiveDate" : { "type" : "string", "description" : "A string representing the date when the contract change becomes effective, in the format 'date'.", "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 LineItemChangeRequest object.", "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 that specifies 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, provided as an object with additional properties that are arrays of strings.", "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. It is formatted as a UUID.", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "Further information about the error, represented as an array of ErrorDetail objects.", "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 } }, "description" : "Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.", "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, represented as a string.", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition, represented as an object where each key is a string and each value is an array of strings. This provides additional information about the error.", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found. This is an optional string field.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate. This is a required field and is of type string.", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error, provided as a string.", "example" : null } }, "description" : "Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.", "example" : null }, "LineItem" : { "required" : [ "id", "name", "pricing", "quantity" ], "type" : "object", "properties" : { "acv" : { "type" : "number", "description" : "The annual contract value for this line item. A number.", "example" : null }, "allowBuyerSelectedQuantity" : { "type" : "boolean", "description" : "Indicates whether the buyer can select the quantity of this line item. A boolean value.", "example" : null }, "amount" : { "type" : "number", "description" : "The total amount for this line item, calculated as price multiplied by quantity. A number.", "example" : null }, "archived" : { "type" : "boolean", "description" : "Indicates whether this line item is archived. A boolean value.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when this line item was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "arr" : { "type" : "number", "description" : "The annual recurring revenue for this line item. A number.", "example" : null }, "billingCycleAnchorDate" : { "type" : "string", "description" : "The anchor date for the billing cycle, in ISO 8601 date format.", "format" : "date", "example" : null }, "billingPeriodEndDate" : { "type" : "string", "description" : "The end date of the billing period, in ISO 8601 date format.", "format" : "date", "example" : null }, "billingPeriodStartDate" : { "type" : "string", "description" : "The start date of the billing period, in ISO 8601 date format.", "format" : "date", "example" : null }, "billingStartDelayDays" : { "type" : "integer", "description" : "The delay in days before billing starts. An integer.", "format" : "int32", "example" : null }, "billingStartDelayMonths" : { "type" : "integer", "description" : "The delay in months before billing starts. An integer.", "format" : "int32", "example" : null }, "billingStartDelayType" : { "type" : "string", "description" : "The type of delay before billing starts. 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 the buyer can select for this line item. A number.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "number", "description" : "The minimum quantity the buyer can select for this line item. A number.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this 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 this line item. A number.", "example" : null }, "discountPercentage" : { "type" : "number", "description" : "The discount percentage applied to this line item. A number.", "example" : null }, "effectiveUnitPrice" : { "type" : "number", "description" : "The effective price per unit after discounts. A number.", "example" : null }, "externalId" : { "type" : "string", "description" : "An external identifier for this line item.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this line item.", "example" : null }, "images" : { "type" : "string", "description" : "A URL or reference to images associated with this line item.", "example" : null }, "isEditablePrice" : { "type" : "boolean", "description" : "Indicates whether the price of this line item is editable. A boolean value.", "example" : null }, "isOptional" : { "type" : "boolean", "description" : "Indicates whether this line item is optional. A boolean value.", "example" : null }, "isParent" : { "type" : "boolean", "description" : "Indicates whether this line item is a parent item. A boolean value.", "example" : null }, "lineItemCurrencyCode" : { "type" : "string", "description" : "The currency code for this line item, following ISO 4217 format.", "example" : null }, "mrr" : { "type" : "number", "description" : "The monthly recurring revenue for this line item. A number.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the line item.", "example" : null }, "parentLineItemId" : { "type" : "string", "description" : "The unique identifier for the parent line item, if applicable.", "example" : null }, "positionOnQuote" : { "type" : "integer", "description" : "The position of this line item on a quote. An integer.", "format" : "int32", "example" : null }, "postTaxAmount" : { "type" : "number", "description" : "The total amount after tax is applied. A number.", "example" : null }, "preDiscountAmount" : { "type" : "number", "description" : "The amount before any discounts are applied. A number.", "example" : null }, "price" : { "type" : "number", "description" : "The price of a single unit of the line item. A number.", "example" : null }, "priceBookId" : { "type" : "string", "description" : "The unique identifier for the price book associated with this line item.", "example" : null }, "pricing" : { "$ref" : "#/components/schemas/Pricing" }, "pricingModel" : { "type" : "string", "description" : "The pricing model used for this 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 this line item.", "example" : null }, "productType" : { "type" : "string", "description" : "The type of product for this line item.", "example" : null }, "quantity" : { "type" : "number", "description" : "The quantity of the line item. A number.", "example" : null }, "rampKey" : { "type" : "string", "description" : "A unique identifier for the ramp associated with this line item.", "example" : null }, "recurringBillingDayOfMonth" : { "type" : "integer", "description" : "The day of the month on which recurring billing occurs. An integer.", "format" : "int32", "example" : null }, "recurringBillingEndDate" : { "type" : "string", "description" : "The end date for recurring billing, in ISO 8601 date format.", "format" : "date", "example" : null }, "recurringBillingFrequency" : { "type" : "string", "description" : "The frequency of recurring billing for this 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 for recurring billing. 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 date 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 (SKU) for this line item.", "example" : null }, "tax" : { "type" : "number", "description" : "The tax rate applied to this line item. A number.", "example" : null }, "taxAmount" : { "type" : "number", "description" : "The total tax amount for this line item. A number.", "example" : null }, "taxCategory" : { "type" : "string", "description" : "The tax category for this line item.", "example" : null }, "taxRateGroupId" : { "type" : "string", "description" : "The unique identifier for the tax rate group associated with this line item.", "example" : null }, "tcv" : { "type" : "number", "description" : "The total contract value for this line item. A number.", "example" : null }, "termInMonths" : { "type" : "integer", "description" : "The term length in months for this line item. An integer.", "format" : "int32", "example" : null }, "tierAmount" : { "type" : "number", "description" : "The amount for the current pricing tier. A number.", "example" : null }, "totalDiscount" : { "type" : "number", "description" : "The total discount amount for this line item. A number.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when this 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 this 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" : "Details of the line item to be added. This can be 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, 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" : { "description" : "An object representing the added line item details if the action was 'ADD'. This can be one of several types, such as custom, from a product, or a clone.", "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 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 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 a buyer can select for the line item.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "object", "properties" : { }, "description" : "An object representing the minimum quantity that a 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 }, "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 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 discount percentage 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, with a default value of 'CLONE'.", "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 period of recurring billing for 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" : { }, "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, "x-hubspot-sub-type-impl" : true }, "LineItemCustomCreateRequest" : { "title" : "CUSTOM", "required" : [ "mode", "name", "pricing", "quantity" ], "type" : "object", "properties" : { "allowBuyerSelectedQuantity" : { "type" : "boolean", "description" : "A boolean indicating 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 delay in days before billing starts.", "format" : "int32", "example" : null }, "billingStartDelayMonths" : { "type" : "integer", "description" : "An integer representing the delay in months before billing starts.", "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 indicating 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 amount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "number", "description" : "A number indicating the discount percentage applied to the line item.", "example" : null }, "externalId" : { "type" : "string", "description" : "A string representing an external identifier for the line item.", "example" : null }, "images" : { "type" : "string", "description" : "A string containing image URLs associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "boolean", "description" : "A boolean indicating whether 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 indicating the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string indicating the mode of the line item, which is 'CUSTOM' by default.", "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 the quote.", "format" : "int32", "example" : null }, "priceBookId" : { "type" : "string", "description" : "A string indicating the price book ID associated with the line item.", "example" : null }, "pricing" : { "$ref" : "#/components/schemas/PricingFullUpdateRequest" }, "productId" : { "type" : "string", "description" : "A string representing the product ID 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 indicating the quantity of the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "string", "description" : "A string in date format representing the end date for recurring billing.", "format" : "date", "example" : null }, "recurringBillingFrequency" : { "type" : "string", "description" : "A string representing the frequency of recurring billing, with valid values including 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', '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 indicating the period for recurring billing.", "example" : null }, "recurringBillingStartDate" : { "type" : "string", "description" : "A string in date format indicating the start date for 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", "description" : "A string representing the tax category for the line item.", "example" : null }, "taxRateGroupId" : { "type" : "string", "description" : "A string indicating the tax rate group ID applicable to the line item.", "example" : null }, "variantId" : { "type" : "string", "description" : "A string representing the variant ID of the product.", "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 delay in days before billing starts.", "example" : null }, "billingStartDelayMonths" : { "type" : "object", "properties" : { }, "description" : "An object representing the delay in months before billing starts.", "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 providing a 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 an external identifier for the line item.", "example" : null }, "images" : { "type" : "object", "properties" : { }, "description" : "An object containing 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, with a default value of '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 indicating 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 for 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 providing a 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" : { }, "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 product.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "PriceEntry" : { "required" : [ "currencyCode", "price" ], "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The currency 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 an integer.", "format" : "int32", "example" : null }, "price" : { "type" : "number", "description" : "The cost of the product or service in the specified currency, represented as a number.", "example" : null } }, "example" : null }, "PriceUpdateEntry" : { "required" : [ "currencyCode", "price" ], "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "A string representing the currency in which the price is specified.", "example" : null }, "maxQuantity" : { "type" : "integer", "description" : "An integer indicating the maximum quantity applicable for this price entry.", "format" : "int32", "example" : null }, "price" : { "type" : "object", "properties" : { }, "description" : "An object representing the price details for the entry.", "example" : null } }, "example" : null }, "Pricing" : { "required" : [ "prices", "pricingModel" ], "type" : "object", "properties" : { "prices" : { "type" : "array", "description" : "An array of price entries, each specifying a currency code and the corresponding price for the line item.", "example" : null, "items" : { "$ref" : "#/components/schemas/PriceEntry" } }, "pricingModel" : { "type" : "string", "description" : "The pricing model applied to the 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 price entries that define the specific pricing details for the contract. Each entry includes currency and price information.", "example" : null, "items" : { "$ref" : "#/components/schemas/PriceUpdateEntry" } }, "pricingModel" : { "type" : "string", "description" : "The pricing model applied to the contract. 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", "description" : "The unique identifier of the contract to which the change applies.", "example" : null }, "dealId" : { "type" : "string", "description" : "The unique identifier of the associated deal.", "example" : null }, "dealPipeline" : { "type" : "string", "description" : "A string representing the pipeline of the associated deal.", "example" : null }, "dealStage" : { "type" : "string", "description" : "A string representing the stage of the associated deal.", "example" : null }, "effectiveDate" : { "type" : "string", "description" : "The date when the contract change becomes effective, in the format 'date'.", "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" : "The unique identifier of the quote template used for the contract change.", "example" : null }, "type" : { "type" : "string", "description" : "The type of contract change, which is set to '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 for the buyer's company associated with the quote.", "example" : null }, "buyerContactId" : { "type" : "string", "description" : "The unique identifier for 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 for 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 the electronic signing process.", "format" : "int32", "example" : null }, "esignNumSignersRequired" : { "type" : "integer", "description" : "The total number of signers required to complete the electronic signing process.", "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, affecting formatting and presentation.", "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.", "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.", "example" : null }, "senderEmail" : { "type" : "string", "description" : "The email address of the sender.", "example" : null }, "senderFirstname" : { "type" : "string", "description" : "The first name of the sender.", "example" : null }, "senderJobtitle" : { "type" : "string", "description" : "The job title of the sender.", "example" : null }, "senderLastname" : { "type" : "string", "description" : "The last name of the sender.", "example" : null }, "senderPhone" : { "type" : "string", "description" : "The phone number of the sender.", "example" : null }, "showSignatureBox" : { "type" : "boolean", "description" : "Indicates whether the signature box is shown 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 in which the quote is applicable.", "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" } }