Advanced

Cancel a subscription

Changed on

Cancel an active commerce subscription using the subscription ID.

post/payments-subscriptions/2026-09-beta/subscriptions/crm/{objectId}/cancel

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/payments-subscriptions/2026-09-beta/subscriptions/crm/{objectId}/cancel
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.schemas.subscriptions.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.subscriptions.write

Path parameters

objectIdinteger required

The ID of the subscription

Response

An error occurred.

categorystring required

The error category

contextobject

Context about the error condition

correlationIdstring uuid required

A unique identifier for the request. Include this value with any error reports or support tickets

linksobject

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

messagestring required

A human readable message describing the error along with remediation steps where appropriate

subCategorystring

A specific category that contains more specific detail about the error

Example response

{
  "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"
  }
}

Changes

  • 2026-09-betaf687fd0095a3Revision changes
    • info

      the security scope crm.schemas.subscriptions.write was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.objects.subscriptions.write was removed from the endpoint's security scheme oauth2

  • 2026-09-beta6cba99a27eedRevision changes
    • info

      the security scope crm.schemas.subscriptions.write was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.objects.subscriptions.write was removed from the endpoint's security scheme oauth2