> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve all subscription status definitions

> Obtener una lista de definiciones de estado de suscripción de la cuenta.

export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
  const translations = {
    header: "Productos compatibles",
    description: "Se requiere uno de los siguientes productos o productos de ediciones superiores.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub"
    },
    tiers: {
      free: "Gratuito",
      starter: "Starter",
      professional: "Pro",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="STARTER" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'communication_preferences.read',
  'communication_preferences.read_write'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/2026-09/communication-preferences-subscriptions-v2026-09.json GET /communication-preferences/2026-09/definitions
openapi: 3.0.1
info:
  title: Communication Preferences Subscriptions
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: STARTER
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Batch
  - name: Definitions
  - name: Status
paths:
  /communication-preferences/2026-09/definitions:
    get:
      tags:
        - Definitions
      summary: Recuperar todas las definiciones de estado de suscripción
      description: Obtener una lista de definiciones de estado de suscripción de la cuenta.
      operationId: get-/communication-preferences/2026-09/definitions
      parameters:
        - name: businessUnitId
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
        - name: includeTranslations
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ActionResponseWithResultsSubscriptionDefinition
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - communication_preferences.read_write
components:
  schemas:
    ActionResponseWithResultsSubscriptionDefinition:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: La fecha y la hora en que se completó la operación.
          format: date-time
        errors:
          type: array
          description: Una matriz de los errores que se produjeron durante la operación.
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: Una recopilación de enlaces asociados con la operación.
        numErrors:
          type: integer
          description: El número de errores encontrados durante la operación.
          format: int32
        requestedAt:
          type: string
          description: La fecha y la hora en que se solicitó la operación.
          format: date-time
        results:
          type: array
          description: Una matriz que contiene los resultados de la operación.
          items:
            $ref: '#/components/schemas/SubscriptionDefinition'
        startedAt:
          type: string
          description: La fecha y la hora en que se inició la operación.
          format: date-time
        status:
          type: string
          description: >-
            El estado actual de la operación, puede ser PENDIENTE, PROCESANDO,
            CANCELADO o COMPLETADO.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: Una cadena que clasifica el tipo de error.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Un objeto que contiene contexto adicional sobre la condición del
            error, con claves como nombres de contexto y valores como conjuntos
            de cadenas.
        errors:
          type: array
          description: >-
            Un conjunto de objetos ErrorDetail que proporciona más información
            sobre el error.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: Una cadena que representa el identificador único del error.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Un objeto que asigna nombres de enlaces a URI asociados que
            contienen documentación sobre el error o los pasos de solución
            recomendados.
        message:
          type: string
          description: >-
            Una cadena que contiene un mensaje comprensible para los humanos que
            describe el error.
        status:
          type: string
          description: Una cadena que indica el estado del error.
        subCategory:
          type: object
          properties: {}
          description: >-
            Un objeto que proporciona una categorización más específica del
            error.
      description: Ye olde error
    SubscriptionDefinition:
      required:
        - createdAt
        - description
        - id
        - isActive
        - isDefault
        - isInternal
        - name
        - updatedAt
      type: object
      properties:
        businessUnitId:
          type: integer
          description: El ID de la unidad de negocio asociada a la suscripción.
          format: int64
        communicationMethod:
          type: string
          description: El método de comunicación para la suscripción.
        createdAt:
          type: string
          description: La fecha y hora en que se creó la suscripción.
          format: date-time
        description:
          type: string
          description: Una descripción de la suscripción.
        id:
          type: string
          description: El identificador único de la suscripción.
        isActive:
          type: boolean
          description: Indica si la suscripción está activa.
        isDefault:
          type: boolean
          description: Indica si la suscripción es la opción predeterminada.
        isInternal:
          type: boolean
          description: Indica si la suscripción es interna.
        name:
          type: string
          description: El nombre de la suscripción.
        purpose:
          type: string
          description: El propósito de la suscripción.
        subscriptionTranslations:
          type: array
          description: Una lista de traducciones asociadas a la suscripción.
          items:
            $ref: '#/components/schemas/PublicSubscriptionTranslation'
        updatedAt:
          type: string
          description: La fecha y hora en que se actualizó por última vez la suscripción.
          format: date-time
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La categoría del error
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto de la condición de error
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identificador único para la solicitud. Incluye este valor con
            cualquier informe de error o ticket de asistencia.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: información adicional acerca del error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Un mapa de nombres de enlaces a las URI asociadas que contienen
            documentación sobre el error o los pasos recomendados para
            solucionarlo
        message:
          type: string
          description: >-
            Un mensaje legible en el que se describa el error y los pasos para
            solucionarlo, si procede
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Una categoría específica que contiene detalles más concretos acerca
            del error
      description: >-
        Representa una respuesta de error que devuelve la API cuando una
        operación falla. Este componente se usa en varios puntos de terminación
        para dar información detallada sobre el error que se encontró.
      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: El código de estado asociado al detalle del error
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto de la condición de error
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: El nombre del campo o parámetro en el que se encontró el error.
        message:
          type: string
          description: >-
            Un mensaje legible en el que se describa el error y los pasos para
            solucionarlo, si procede
        subCategory:
          type: string
          description: >-
            Una categoría específica que contiene detalles más concretos acerca
            del error
      description: >-
        Representa información detallada sobre un error que ocurrió en la API.
        Este componente se usa para dar contexto adicional y detalles
        específicos sobre los errores, normalmente como parte de una respuesta
        de error.
    PublicSubscriptionTranslation:
      required:
        - createdAt
        - description
        - languageCode
        - name
        - subscriptionId
        - updatedAt
      type: object
      properties:
        createdAt:
          type: integer
          description: >-
            La marca de tiempo que indica cuándo se creó la traducción de la
            suscripción.
          format: int64
        description:
          type: string
          description: Una descripción de texto de la traducción de la suscripción.
        languageCode:
          type: string
          description: >-
            El código que representa el idioma de la traducción de la
            suscripción.
        name:
          type: string
          description: El nombre de la traducción de la suscripción.
        subscriptionId:
          type: integer
          description: El identificador único de la suscripción asociada a la traducción.
          format: int64
        updatedAt:
          type: integer
          description: >-
            La marca de tiempo que indica cuándo se actualizó por última vez la
            traducción de la suscripción.
          format: int64
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            communication_preferences.read_write: ''
            communication_preferences.statuses.batch.read: ''
            communication_preferences.statuses.batch.write: ''

````