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

# List subscription estimates

> Retrieve the estimated quantities currently sold for the subscription's usage-based and connected seat products, resolved across the signed quotes it comes from: a later signed update quote replaces the earlier estimates from its start, so each period has a single current estimate to compare with the measured usage.



## OpenAPI

````yaml get /v1/subscriptions/{id}/estimates
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/subscriptions/{id}/estimates:
    get:
      tags:
        - Subscriptions
      summary: List subscription estimates
      description: >-
        Retrieve the estimated quantities currently sold for the subscription's
        usage-based and connected seat products, resolved across the signed
        quotes it comes from: a later signed update quote replaces the earlier
        estimates from its start, so each period has a single current estimate
        to compare with the measured usage.
      operationId: listSubscriptionProductEstimates
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSubscriptionProductEstimate'
        '404':
          description: Subscription not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    PaginatedSubscriptionProductEstimate:
      type: object
      properties:
        meta:
          type: object
          properties:
            total:
              type: number
              description: Total of existing items.
              example: 1
            taken:
              type: number
              description: Number of items returned.
              example: 1
            skipped:
              type: number
              description: Number of items skipped.
              example: 0
          required:
            - total
            - taken
            - skipped
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionProductEstimate'
          description: List of SubscriptionProductEstimate.
      required:
        - meta
        - data
    SubscriptionProductEstimate:
      type: object
      properties:
        quote_id:
          type: string
          description: ID of the signed quote the estimate comes from.
          example: quo_hXQCd5y8P3GYXa
        quote_configuration_id:
          type: string
          description: >-
            ID of the quote configuration (`configurations[].id` on the quote)
            the estimate comes from.
          example: qcf_38wZOld6qw1Wo1
        phase_id:
          type:
            - string
            - 'null'
          description: >-
            ID of the subscription phase selling the product when `period_start`
            begins (or the first one starting within the period). For a period
            before the subscription's latest transition, it can be a phase of an
            archived version of the subscription. Null when no phase of the
            subscription sells it then, when `period_start` is null, and for an
            update quote whose scheduled transition hasn't run yet.
          example: sup_7rwmn4Ls1YxPas
        product_id:
          type: string
          description: ID of the estimated product in the catalog.
          example: itm_3kXODIM1sBwBbJ
        price_configuration_id:
          type:
            - string
            - 'null'
          description: >-
            ID of the catalog price configuration the line was priced from on
            the quote, if any.
          example: prc_8f3kXODIM1sBwB
        period_start:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Start of the period the estimate currently covers, as sold by the
            quote (see `configurations[].estimates[].period_start` on the
            quote). Null when the quote couldn't resolve it.
          example: '2026-01-01T00:00:00.000Z'
        period_end:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            End of the period the estimate currently covers: the quote's sold
            period end, or the instant before a later signed quote starts
            replacing the subscription. Null when `period_start` is.
          example: '2026-12-31T23:59:59.999Z'
        estimated_count:
          type: number
          description: Estimated number of units per billing period.
          example: 200
        estimated_amount:
          type:
            - number
            - 'null'
          description: >-
            Amount of one billing period of the line priced at the estimate,
            excluding taxes, with its discounts applied, as frozen on the quote.
            Null when the estimate doesn't raise the price.
          example: 2000
        estimated_total_amount:
          type:
            - number
            - 'null'
          description: >-
            What the line bills at the estimate over the period sold by the
            quote, excluding taxes. Null when `estimated_amount` is, or when a
            later signed quote cut the period short.
          example: 24000
      required:
        - quote_id
        - quote_configuration_id
        - phase_id
        - product_id
        - price_configuration_id
        - period_start
        - period_end
        - estimated_count
        - estimated_amount
        - estimated_total_amount
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.