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

# List prices

> Returns a paginated list of prices. When productId is supplied, only prices belonging to that product are returned; otherwise all prices for the portal are returned. Requires internal-user privileges.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/prices
openapi: 3.0.0
info:
  contact: {}
  title: Assembly API
  version: 0.0.1
servers:
  - url: https://api.assembly.com
security: []
paths:
  /v1/prices:
    get:
      tags:
        - Prices
      summary: List prices
      description: >-
        Returns a paginated list of prices. When productId is supplied, only
        prices belonging to that product are returned; otherwise all prices for
        the portal are returned. Requires internal-user privileges.
      operationId: list-prices
      parameters:
        - description: Filter prices by product ID.
          in: query
          name: productId
          schema:
            type: string
        - description: Maximum number of records to return.
          in: query
          name: limit
          schema:
            type: integer
        - description: Pagination cursor returned by a previous request.
          in: query
          name: nextToken
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/price.GetPricesResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dispatcher.Error'
          description: Invalid pagination parameters
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dispatcher.Error'
          description: Unexpected server error
      security:
        - APIKeyHeader: []
components:
  schemas:
    price.GetPricesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/price.Price'
          nullable: true
          type: array
        nextToken:
          description: base64 encoded JSON representing a NextToken
          type: string
      type: object
    dispatcher.Error:
      properties:
        code:
          type: string
        data: {}
        message:
          type: string
      type: object
    price.Price:
      properties:
        amount:
          description: >-
            Amount is the price amount in the smallest currency unit (e.g.
            cents).
          example: 5000
          type: integer
        createdAt:
          type: string
        creatorId:
          type: string
        currency:
          default: usd
          description: >-
            Currency is the ISO-4217 currency code. Defaults to usd when
            omitted.
          example: usd
          type: string
        data:
          type: string
        id:
          type: string
        identityId:
          type: string
        interval:
          allOf:
            - $ref: '#/components/schemas/billingutils.BillingPeriodType'
          description: Interval is the recurring billing period. Omit for one-time prices.
          enum:
            - day
            - week
            - month
            - quarterly
            - biannually
            - year
            - semiannually
          example: month
        intervalCount:
          description: >-
            IntervalCount is the number of intervals between billings for a
            recurring price.
          example: 1
          nullable: true
          type: integer
        isUsed:
          description: >-
            IsUsed indicates whether the price is already referenced by a
            subscription or invoice and therefore cannot be deleted.
          example: false
          type: boolean
        object:
          type: string
        portalId:
          description: PortalID is the ID of the portal that owns this price.
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          type: string
        previousAttributes:
          additionalProperties: true
          type: object
        productId:
          description: ProductId is the ID of the product this price belongs to.
          example: d1f8c9e2-3b4a-4c5d-9e6f-7a8b9c0d1e2f
          format: uuid
          type: string
        ref:
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/price.PriceType'
          description: >-
            Type is a computed field and should not be used in any logic on BE
            or Webapp
          enum:
            - oneTime
            - recurring
          example: recurring
        updatedAt:
          type: string
      type: object
    billingutils.BillingPeriodType:
      enum:
        - day
        - week
        - month
        - quarterly
        - biannually
        - year
        - semiannually
      type: string
      x-enum-varnames:
        - BillingPeriodTypeDay
        - BillingPeriodTypeWeek
        - BillingPeriodTypeMonth
        - BillingPeriodTypeQuarter
        - BillingPeriodTypeBiannual
        - BillingPeriodTypeYear
        - BillingPeriodTypeSemiAnnually
    price.PriceType:
      enum:
        - oneTime
        - recurring
      type: string
      x-enum-varnames:
        - PriceTypeOneTime
        - PriceTypeRecurring
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-KEY
      type: apiKey

````