# HubSpot docs: APIs 2027-03-beta ## 2027-03-beta - [2027-03 in beta](https://developers.hubspot.com/docs/api-reference/2027-03-beta/overview.md): Reference documentation for HubSpot's 2027-03-beta APIs, available for early access testing. ### Automation #### Workflows - [Workflows API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/guide.md): Learn how to use the Workflows API. - [Workflow actions and enrollment types (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/action-enrollment-reference.md): Review the different action and enrollment event types for the Workflows API. - [Create workflow](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/create-workflow.md): Create a new automation flow in your HubSpot account using the AutomationFlowApiService. This endpoint allows you to define the flow's properties and actions, enabling automated processes tailored to your business needs. Ensure that the request body is correctly structured as per the ApiFlowCreateRe… - [Retrieve workflow](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/get-workflow.md): Retrieve detailed information about a specific automation flow in your HubSpot account using its unique identifier. This endpoint is useful for obtaining the current configuration and status of a flow, which can aid in monitoring and managing your automation processes. - [Retrieve workflows](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/get-workflows.md): Retrieve a list of automation flows available in your HubSpot account. This endpoint supports pagination to navigate through large sets of flows, allowing you to specify the number of results per page and to continue from a specific point in the list using a cursor token. - [Update workflow](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/update-workflow.md): Update an existing automation flow in your HubSpot account. This endpoint allows you to modify the properties of a specific flow identified by its flowId. It is useful for making changes to the configuration or behavior of an automation flow. - [Delete workflow](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/delete-workflow.md): Delete an existing automation flow in your HubSpot account using the specified flow ID. This operation will permanently remove the flow and cannot be undone. Use this endpoint to manage and clean up automation flows that are no longer needed. ##### Action types - [Retrieve action types](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/action-types/get-action-types.md): Retrieve a list of available workflow action types. This endpoint can be used to understand the types of actions that can be incorporated into automation workflows, which is useful for developers looking to customize or extend workflow capabilities. ##### Batch - [Batch retrieve workflows](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/batch/get-workflows.md): Retrieve multiple automation flows in a single request. This endpoint is useful for efficiently fetching data about several flows at once, reducing the need for multiple API calls. It is ideal for applications that need to process or display information about multiple flows simultaneously. ##### Emails - [Retrieve workflow email campaigns](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/emails/get-email-campaigns.md): Retrieve a list of email campaigns associated with automation flows. This endpoint allows you to filter and paginate through email campaigns using various query parameters. It is useful for obtaining detailed information about email campaigns linked to specific flows. ##### Revisions - [Retrieve revision](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/revisions/get-revision.md): Retrieve a specific revision of an automation flow using its flow ID and revision ID. This endpoint is useful for accessing historical versions of a flow to review changes or restore previous configurations. ##### Workflow ID mappings - [Batch retrieve workflow ID mappings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/automation/workflows/workflow-id-mappings/get-workflow-id-mappings.md): Retrieve batch workflow ID mappings for automation flows. This endpoint allows you to submit a batch request to read multiple workflow ID mappings in one operation, facilitating efficient data retrieval for large sets of automation flows. ### CMS #### Knowledge base - [Knowledge base API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/guide.md): Create and manage articles, categories, and tags in your HubSpot knowledge base. - [Create an article](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/create-article.md): Creates a new article under the specified knowledge base and language in a draft state. Requires knowledgeBaseId, title, and language; optionally accepts subtitle, body, categoryId, path, metaDescription, tagIds, accessType, accessGroupIds, and translationOfId (to link this article as a translation… - [Retrieve an article](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/get-article.md): Retrieve a specific article from the knowledge base using its unique identifier. - [Retrieve all articles](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/get-articles.md): Retrieve a list of articles from the knowledge base. This endpoint allows filtering and sorting articles based on creation and update timestamps, state, language, and other attributes. It supports pagination and can include additional details such as the article body and translations. - [Retrieve a knowledge base](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/get-knowledge-base.md): Retrieve a specific knowledge base by its ID. Returns its name, language, domain, URL, access settings, language variants (translations), and related metadata. - [Retrieve all knowledge bases](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/get-knowledge-bases.md): Retrieve a paginated list of knowledge bases in your HubSpot account. Supports filtering by creation and update timestamps, as well as sorting. - [Unpublish an article](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/unpublish-article.md): Unpublish a specific article in the knowledge base by its ID. - [Update an article](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/update-article.md): Update an existing article using its unique identifier. Only the fields included in the request are modified — omitted fields are left unchanged. Supports updating title, subtitle, body, category, tags, access settings, and metadata. ArchivedInDashboard is a CMS-specific property that controls the a… ##### Categories - [Retrieve all categories](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/categories/get-categories.md): Retrieve a paginated list of categories from the knowledge base. Supports filtering by knowledge base ID, parent category ID, language, and creation/update timestamps, as well as sorting. - [Retrieve featured articles for a category](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/categories/get-category-featured-articles.md): Retrieve the featured articles for a specific category in the knowledge base. Articles marked as featured within a given category are displayed on the Knowledge Base's homepage. - [Retrieve a category](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/categories/get-category.md): Retrieve a specific category by its ID. ##### Drafts - [Retrieve a draft](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/drafts/get-draft.md): Retrieve the draft version of a specific article in the knowledge base. This endpoint allows you to access the draft content of an article, which can be useful for reviewing or editing purposes before publishing. - [Publish a draft](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/drafts/publish-draft.md): Push a draft version of a knowledge base article live. This operation is useful when you want to make the latest changes to an article available to the public. Ensure that the draft is finalized before performing this action. - [Update a draft](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/drafts/update-draft.md): Update the draft version of a specific knowledge base article. This endpoint allows you to modify the draft content of an article, including its title, body, and other properties. Use this endpoint to stage changes to an article before it is published live. ##### Tags - [Retrieve a tag](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/tags/get-tag.md): Retrieve a Knowledge Base tag by the ID in the path. - [Retrieve all tags](https://developers.hubspot.com/docs/api-reference/2027-03-beta/cms/knowledge-base/tags/get-tags.md): Retrieve a paginated list of knowledge base tags. Supports filtering by knowledge base ID, language, and creation/update timestamps, as well as sorting. ### CRM #### Associations ##### Auto associations - [Auto-associations API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/crm/associations/auto-associations/guide.md): Read and update how HubSpot automatically associates activities with CRM objects. - [Retrieve Auto Association customization](https://developers.hubspot.com/docs/api-reference/2027-03-beta/crm/associations/auto-associations/get-activity-auto-associations.md): Retrieve the auto-association settings for a specific object type in HubSpot. This endpoint allows you to view the current selection and available options for automatic associations related to the specified object type. - [Retrieve Auto Association defaults](https://developers.hubspot.com/docs/api-reference/2027-03-beta/crm/associations/auto-associations/get-default-activity-auto-associations.md): Retrieve the default auto-association behaviors for a specified object type in your HubSpot account. This endpoint allows you to understand the default settings applied to automatic associations, which can help in managing and configuring CRM associations effectively. - [Batch upsert](https://developers.hubspot.com/docs/api-reference/2027-03-beta/crm/associations/auto-associations/upsert-activity-auto-associations.md): Perform a batch upsert of auto-association settings in your HubSpot account. This endpoint allows you to update or insert multiple auto-association customizations at once, streamlining the process of managing these settings. The request body must include an array of association customizations to ups… ### Marketing #### AEO - [AEO API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/aeo/guide.md): Use the AEO API to retrieve AI visibility data, including tracked prompts, prompt run histories, and content recommendations. - [Retrieve prompt](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/aeo/get-aeo-promptId.md): Retrieve detailed information about a specific prompt, including its visibility settings, using the prompt's unique identifier. This endpoint is useful for obtaining insights into a prompt's configuration and its associated data within the specified date range. - [Retrieve recommendation](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/aeo/get-aeo-recommendationId.md): Retrieve a specific recommendation by its unique identifier. This endpoint is useful for accessing detailed information about a particular recommendation within your HubSpot account. - [Retrieve prompt run](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/aeo/get-aeo.md): Retrieve detailed information about a specific prompt run using its unique identifier. This endpoint provides insights into the run's state, associated AI model, citations, and mentions. It is useful for tracking the progress and results of a prompt run within the Answer Engine Visibility system. - [List prompts](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/aeo/get-prompts.md): Retrieve a list of prompts from the AnswerEngineVisibilityPublicApi. This endpoint allows you to filter and sort prompts based on various criteria, such as creation date and business unit. Use this endpoint to manage and view prompts efficiently. - [List recommendations](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/aeo/get-recommendations.md): Retrieve a list of recommendations from the AnswerEngineVisibilityPublicApi. This endpoint allows users to filter and sort recommendations based on various criteria such as prompt ID, status, and recommendation type. It supports pagination and sorting to efficiently manage large sets of data. #### Forms - [Forms API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/guide.md): These endpoints are used to create and manage forms in your HubSpot account. - [Create a form](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/create-form.md) - [Get a form definition](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/get-form.md): Retrieve details of a specific form in your HubSpot account using the form's unique identifier. This endpoint allows you to access information about a form, including its configuration and display options. You can also specify whether to include archived forms in the response. - [Get all forms](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/get-forms.md) - [Partially update a form definition](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/update-form-formId.md): Update an existing form in your HubSpot account by specifying the form ID. This operation allows you to modify the form's properties, such as its name, field groups, configuration, display options, legal consent options, and archived status. This is useful for keeping forms up to date with your curr… - [Update a form definition](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/update-form.md): Update an existing form in your HubSpot account using the specified form ID. This endpoint allows you to modify the properties of a form, such as its configuration, display options, and legal consent options. Ensure that the form ID is valid and that you have the necessary permissions to update form… - [Archive a form definition](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/forms/delete-form.md): Delete a specific form from your HubSpot account using its unique identifier. This operation will permanently remove the form and cannot be undone. Ensure that you have the necessary permissions before performing this action. #### Lead Scoring - [Lead Scoring API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/guide.md): Create, manage, and retrieve score configurations and score values for CRM objects. - [Deactivate score](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/create-lead-scoring-scoreId.md): Deactivate a specific lead scoring configuration in your HubSpot account. This endpoint is useful when you want to temporarily disable a scoring configuration without deleting it. The operation returns the updated score configuration. - [Clone score](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/create-lead-scoring.md): Clone an existing lead scoring configuration in your HubSpot account. This operation allows you to duplicate a score configuration identified by the scoreId path parameter, which can then be modified or used as a template for new scoring rules. - [Retrieve draft](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/get-lead-scoring-draft.md): Retrieve the draft configuration of a specific lead scoring model using its score ID. This endpoint is useful for accessing the draft version of a score configuration before it is published or finalized. - [Retrieve score](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/get-lead-scoring-scoreId.md): Retrieve the configuration details of a specific lead scoring model in your HubSpot account using its unique score ID. This endpoint is useful for accessing the setup and parameters of a particular scoring model to understand how leads are being evaluated. - [Retrieve history](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/get-lead-scoring.md): Retrieve the history of score values for a specific object type and ID in the lead scoring system. This endpoint is useful for tracking changes in score values over time and understanding how different factors have influenced the scores. The results can be filtered and paginated using the provided q… - [List scores](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/get-scores.md): Retrieve a list of lead scores from the HubSpot account. This endpoint allows you to view scores for various leads, which can be useful for analyzing lead quality and prioritizing follow-up actions. The results can be paginated using the provided query parameters. - [Update draft](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/update-lead-scoring-draft.md): Update the draft configuration of a lead scoring model identified by the scoreId. This operation allows you to modify the draft settings of an existing lead scoring model, which can be useful for testing or adjusting scoring criteria before publishing. - [Delete](https://developers.hubspot.com/docs/api-reference/2027-03-beta/marketing/lead-scoring/delete-lead-scoring.md): Delete a specific lead scoring configuration in your HubSpot account using its unique identifier. This operation is useful for removing outdated or unnecessary scoring configurations to maintain a clean and efficient scoring system. ### Meetings #### Scheduler - [Meetings scheduler API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/guide.md): Use the meetings API to retrieve information about meetings created through a scheduling page, book a meeting, and manage payment link associations. ##### Calendar - [Create a new calendar event for a meeting](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/calendar/create-calendar-event.md): Create a new calendar meeting event in the HubSpot system. This endpoint allows you to schedule meetings by providing necessary details such as meeting title, start and end times, and associated user information. It is essential for organizing meetings and managing schedules within the HubSpot platf… ##### Meetings - [Book a meeting](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/meetings/create-meeting.md): Book a meeting using a meeting link in your HubSpot account. This endpoint allows you to specify details such as the meeting duration, start time, and participant information. It is useful for scheduling meetings with external participants through a predefined meeting link. - [Retrieve meeting availability](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/meetings/get-availability.md): Retrieve the availability and busy times for a specific meeting link using its slug. This endpoint provides information about when meetings can be scheduled, taking into account the specified timezone and any month offset. It is useful for determining available time slots for booking meetings. - [Retrieve meeting scheduling pages](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/meetings/get-meeting-links.md): Retrieve a list of meeting links available in your HubSpot account. This endpoint allows you to filter the results by various criteria such as the organizer's user ID, meeting type, and name. It supports pagination to help manage large sets of data. - [Retrieve meeting link slug](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/meetings/get-meeting-slug.md): Retrieve information about a specific meeting booking using a unique slug identifier. This endpoint provides details such as availability and busy times for the meeting link. It is useful for checking the status and details of a meeting link before booking. - [Update meeting link](https://developers.hubspot.com/docs/api-reference/2027-03-beta/meetings/scheduler/meetings/update-meeting-link.md): Update the details of a specific meeting link using its unique slug. This operation allows you to modify the settings or metadata associated with a meeting link in your HubSpot account. ### Reporting - [Reporting API](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/guide.md): Retrieve, manage, export, and share reports and dashboards in HubSpot. #### Dashboards - [Get dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/get-reporting-dashboardId.md): Retrieves a single dashboard. - [Create dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/create-dashboard.md): Creates a new dashboard. Existing reports can optionally be attached to the dashboard at creation time; report widgets will be appended sequentially. - [Clone dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/clone-dashboard.md): Clones an existing dashboard. The cloned dashboard may either retain references to the reports on the original dashboard, or clone the original's reports and reference the clones. - [Update dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/update-dashboard.md): Partially updates a dashboard. All fields in the request are optional; only the fields which are present will be updated. - [Export dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/export-dashboard.md): Exports a dashboard's content to one or more HubSpot users via standard HubSpot communication channels (notably, email). - [Add report to dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/add-report-to-dashboard.md): Adds a single report to a dashboard. The report widget is appended to the end of the existing dashboard layout. If the report is already on the dashboard, does not exist, or the requesting user doesn't have permission to access it, does nothing. Check the dashboard in the response to determine wheth… - [Remove report from dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/remove-report-from-dashboard.md): Removes a single report from a dashboard. ##### Batch - [Batch add reports to dashboard](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/batch/batch-add-reports.md): Adds one or more reports to a dashboard. Report widgets are appended to the end of the existing dashboard layout. Any reports which are already on the dashboard, don't exist, or the requesting user doesn't have permissions for are skipped. Check the dashboard in the response to determine which repor… - [Batch archive dashboards](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/batch/batch-archive-dashboards.md): Archives one or more dashboards. Already-archived dashboards are silently ignored. The maximum batch size is 500. - [Batch restore dashboards](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/batch/batch-restore-dashboards.md): Restores one or more archived dashboards. Already-active dashboards are silently ignored. The maximum batch size is 500. - [Batch update dashboard owners](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/batch/batch-update-dashboard-owners.md): Updates the owner of one or more dashboards. The maximum batch size is 500. - [Batch update dashboard permissions](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/batch/batch-update-dashboard-permissions.md): Updates the permissions for one or more dashboards. The maximum batch size is 500. ##### Search - [Search dashboards](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/dashboards/search/search-dashboards.md): Searches for and returns pages of dashboards using a variety of filters. Search is eventually-consistent; changes to dashboards may take a few seconds to reflect in search results. #### Reports - [Get report](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/get-report.md): Retrieves a single report. - [Update report](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/update-report.md): Partially updates a report. All fields in the request are optional; only the fields which are present will be updated. - [Export report](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/export-report.md): Exports a report to one or more HubSpot users via standard HubSpot communication channels (notably, email). ##### Batch - [Batch archive reports](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/batch/batch-archive-reports.md): Archives one or more reports. Already-archived reports are silently ignored. The maximum batch size is 500. - [Batch restore reports](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/batch/batch-restore-reports.md): Restores one or more archived reports. Already-active reports are silently ignored. The maximum batch size is 500. - [Batch update report permissions](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/batch/batch-update-permissions.md): Updates the permissions for one or more reports. The maximum batch size is 500. - [Batch update report owners](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/batch/batch-update-report-owners.md): Updates the owner of one or more reports. The maximum batch size is 500. ##### Search - [Search reports](https://developers.hubspot.com/docs/api-reference/2027-03-beta/reporting/reports/search/search-reports.md): Searches for and returns pages of reports using a variety of filters. Search is eventually-consistent; changes to dashboards may take a few seconds to reflect in search results. ### Revenue #### Contracts - [Contracts API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/guide.md): Create and manage contracts and contract changes programmatically. - [Create contract](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/create-contract.md): 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 detai… - [Retrieve contract](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/get-contract.md): 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… - [Terminate contract](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/terminate-contract.md): 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. - [Update contract](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/update-contract.md): 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. ##### Changes - [Accept Change](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/accept-change.md): 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. - [Cancel Change](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/cancel-change.md): 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. - [Create change](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/create-change.md): 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. - [Retrieve change](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/get-change.md): 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. - [Retrieve changes](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/get-changes.md): 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. - [Preview Changes](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/preview-changes.md): 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. - [Update change](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/contracts/changes/update-change.md): 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. #### Subscriptions - [Subscription lifecycle API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/subscriptions/guide.md): Use the subscription lifecycle API to manage the state of active revenue subscriptions in your HubSpot account. - [Cancel subscription](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/subscriptions/cancel-subscription.md): Cancel an active commerce subscription using the subscription ID. - [Pause subscription](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/subscriptions/pause-subscription.md): Pause an active subscription using the subscription ID. - [Unpause subscription](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/subscriptions/unpause-subscription.md): Resume a previously paused subscription using the subscription ID. #### Payments - [Payments API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payments/guide.md): Create manual payment records and retry failed payments programmatically. - [Create manual payment](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payments/create-payment.md): Create a manual payment in the HubSpot system. This endpoint allows you to specify details such as the payment amount, currency, payment method, and date. It is useful for recording payments that occur outside of automated systems, ensuring all payment data is captured within HubSpot. - [Retry Payment](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payments/retry-payment.md): Initiate an asynchronous retry of a payment associated with the specified CRM object ID. This endpoint is useful for attempting to process payments that may have previously failed or require reprocessing. Upon successful initiation, a task locator is returned to track the status of the retry operati… - [Retrieve status](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payments/get-status.md): Retrieve the status of a specific asynchronous retry task for a payment CRM object. This endpoint allows you to check the progress or completion status of a task that was initiated to retry a payment action. #### Payment Settings - [Payment settings API (BETA)](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/guide.md): Retrieve and update payment settings for your HubSpot account. ##### Payment Methods - [Retrieve payment method settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/get-payment-methods.md): Retrieve the settings for payment methods in your HubSpot account. This endpoint provides information about the current configuration of payment methods, including their capability status and supported currencies. It is useful for understanding which payment methods are active and their default stat… - [Update payment method settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/update-payment-method.md): Update the payment method settings for commerce transactions. This operation allows you to modify the configuration of payment methods, including setting defaults and managing supported currencies. Use this endpoint to ensure your payment methods align with your business requirements. ##### Billing and Shipping - [Retrieve billing settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/get-billing-settings.md): Retrieve the current billing settings for your HubSpot account's payment settings. This endpoint allows you to access billing configurations, which can be useful for managing and reviewing your account's payment setup. - [Update billing settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/update-billing-setting.md): Update the billing settings for your HubSpot account's payment settings. This endpoint allows you to modify the billing configurations, which can be essential for managing how payments are processed and billed. Ensure you have the necessary permissions to write payment checkout settings before makin… - [Retrieve shipping settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/get-shipping.md): Retrieve the current shipping settings for your HubSpot account. This endpoint provides information about the configured shipping options, which can be useful for managing and reviewing your shipping policies and configurations. - [Update shipping settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/update-shipping.md): Update the shipping settings for your HubSpot account. This endpoint allows you to modify existing shipping configurations to better suit your business needs. Ensure that the request body contains the necessary fields as defined in the UpdateShippingSettingsPublicRequest schema. ##### Fees - [Retrieve checkout fees](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/get-checkout-fees.md): Retrieve the current checkout fee settings for your HubSpot account. This endpoint provides information about any fees applied during the checkout process, which can be useful for understanding transaction costs and configuring payment settings. - [Update checkout fees](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/update-checkout-fees.md): Update the checkout fees settings in your HubSpot account. This endpoint allows you to modify the configuration of checkout fees, which can be useful for adjusting fee structures or implementing new pricing strategies. Ensure that the request body contains the necessary details for the update. - [Delete checkout fee](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/delete-checkout-fee.md): Remove a specific checkout fee from the payments settings in your HubSpot account. This operation is useful for managing and updating the fees associated with checkout processes. Ensure you have the necessary permissions to perform this action. ##### Policies - [Retrieve policy settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/get-policy.md): Retrieve the current payment policy settings for your HubSpot account. This endpoint provides access to the policy configurations related to payment settings, allowing you to review the existing setup. It is useful for ensuring compliance with organizational or regulatory requirements by reviewing t… - [Update policy settings](https://developers.hubspot.com/docs/api-reference/2027-03-beta/revenue/payment-settings/update-policy.md): Update the payment policy settings for your HubSpot account. This endpoint allows you to modify existing policy configurations, which can include terms and conditions related to payments. Ensure that you have the necessary permissions to write payment checkout settings before making changes. ## OpenAPI Specs - [automation-automation-v4-v2027-03-beta](/docs/specs/2027-03-beta/automation-automation-v4-v2027-03-beta.json) - [cms-knowledge-base-v2027-03-beta](/docs/specs/2027-03-beta/cms-knowledge-base-v2027-03-beta.json) - [crm-activity-auto-associations-v2027-03-beta](/docs/specs/2027-03-beta/crm-activity-auto-associations-v2027-03-beta.json) - [marketing-aeo-v2027-03-beta](/docs/specs/2027-03-beta/marketing-aeo-v2027-03-beta.json) - [marketing-forms-v2027-03-beta](/docs/specs/2027-03-beta/marketing-forms-v2027-03-beta.json) - [marketing-lead-scoring-v2027-03-beta](/docs/specs/2027-03-beta/marketing-lead-scoring-v2027-03-beta.json) - [scheduler-meetings-v2027-03-beta](/docs/specs/2027-03-beta/scheduler-meetings-v2027-03-beta.json) - [analytics-reporting-v2027-03-beta](/docs/specs/2027-03-beta/analytics-reporting-v2027-03-beta.json) - [commerce-contracts-v2027-03-beta](/docs/specs/2027-03-beta/commerce-contracts-v2027-03-beta.json) - [crm-subscription-lifecycle-v2027-03-beta](/docs/specs/2027-03-beta/crm-subscription-lifecycle-v2027-03-beta.json) - [commerce-payments-v2027-03-beta](/docs/specs/2027-03-beta/commerce-payments-v2027-03-beta.json) - [commerce-payment-methods-v2027-03-beta](/docs/specs/2027-03-beta/commerce-payment-methods-v2027-03-beta.json) - [commerce-payments-settings-v2027-03-beta](/docs/specs/2027-03-beta/commerce-payments-settings-v2027-03-beta.json)