HubSpot Commerce Subscriptions API — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: HubSpot Commerce Subscriptions API — Subscriptions
  description: 'HubSpot Commerce Subscriptions API — Subscriptions. 6 operations. Lead operation: Hubspot List Subscriptions.
    Self-contained Naftiko capability covering one Hubspot business surface.'
  tags:
  - Hubspot
  - Subscriptions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUBSPOT_API_KEY: HUBSPOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: commerce-subscriptions-subscriptions
    baseUri: https://api.hubapi.com
    description: HubSpot Commerce Subscriptions API — Subscriptions business capability. Self-contained, no shared references.
    resources:
    - name: crm-v3-objects-subscriptions
      path: /crm/v3/objects/subscriptions
      operations:
      - name: listsubscriptions
        method: GET
        description: Hubspot List Subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to return per page.
        - name: after
          in: query
          type: string
          description: The cursor for pagination to get the next page of results.
        - name: properties
          in: query
          type: string
          description: A comma-separated list of property names to return.
        - name: archived
          in: query
          type: boolean
          description: Whether to return archived subscriptions.
      - name: createsubscription
        method: POST
        description: Hubspot Create a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-v3-objects-subscriptions-search
      path: /crm/v3/objects/subscriptions/search
      operations:
      - name: searchsubscriptions
        method: POST
        description: Hubspot Search Subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-v3-objects-subscriptions-subscriptionId
      path: /crm/v3/objects/subscriptions/{subscriptionId}
      operations:
      - name: getsubscription
        method: GET
        description: Hubspot Get a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: The ID of the subscription to retrieve.
          required: true
        - name: properties
          in: query
          type: string
          description: A comma-separated list of property names to return.
        - name: archived
          in: query
          type: boolean
          description: Whether to return archived subscriptions.
      - name: updatesubscription
        method: PATCH
        description: Hubspot Update a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: The ID of the subscription to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesubscription
        method: DELETE
        description: Hubspot Archive a Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: The ID of the subscription to archive.
          required: true
    authentication:
      type: bearer
      token: '{{env.HUBSPOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: commerce-subscriptions-subscriptions-rest
    port: 8080
    description: REST adapter for HubSpot Commerce Subscriptions API — Subscriptions. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/crm/v3/objects/subscriptions
      name: crm-v3-objects-subscriptions
      description: REST surface for crm-v3-objects-subscriptions.
      operations:
      - method: GET
        name: listsubscriptions
        description: Hubspot List Subscriptions
        call: commerce-subscriptions-subscriptions.listsubscriptions
        with:
          limit: rest.limit
          after: rest.after
          properties: rest.properties
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsubscription
        description: Hubspot Create a Subscription
        call: commerce-subscriptions-subscriptions.createsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/subscriptions/search
      name: crm-v3-objects-subscriptions-search
      description: REST surface for crm-v3-objects-subscriptions-search.
      operations:
      - method: POST
        name: searchsubscriptions
        description: Hubspot Search Subscriptions
        call: commerce-subscriptions-subscriptions.searchsubscriptions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/subscriptions/{subscriptionid}
      name: crm-v3-objects-subscriptions-subscriptionid
      description: REST surface for crm-v3-objects-subscriptions-subscriptionId.
      operations:
      - method: GET
        name: getsubscription
        description: Hubspot Get a Subscription
        call: commerce-subscriptions-subscriptions.getsubscription
        with:
          subscriptionId: rest.subscriptionId
          properties: rest.properties
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesubscription
        description: Hubspot Update a Subscription
        call: commerce-subscriptions-subscriptions.updatesubscription
        with:
          subscriptionId: rest.subscriptionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesubscription
        description: Hubspot Archive a Subscription
        call: commerce-subscriptions-subscriptions.deletesubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-subscriptions-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for HubSpot Commerce Subscriptions API — Subscriptions. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: hubspot-list-subscriptions
      description: Hubspot List Subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-subscriptions-subscriptions.listsubscriptions
      with:
        limit: tools.limit
        after: tools.after
        properties: tools.properties
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-create-subscription
      description: Hubspot Create a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-subscriptions-subscriptions.createsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-search-subscriptions
      description: Hubspot Search Subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: commerce-subscriptions-subscriptions.searchsubscriptions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-get-subscription
      description: Hubspot Get a Subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-subscriptions-subscriptions.getsubscription
      with:
        subscriptionId: tools.subscriptionId
        properties: tools.properties
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-update-subscription
      description: Hubspot Update a Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-subscriptions-subscriptions.updatesubscription
      with:
        subscriptionId: tools.subscriptionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-archive-subscription
      description: Hubspot Archive a Subscription
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-subscriptions-subscriptions.deletesubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.