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

# List pricing calculators



## OpenAPI

````yaml /openapi.json get /pricing-calculators/
openapi: 3.1.0
info:
  title: Journeybee API
  description: >-
    Public REST API for the Journeybee PRM platform.


    Manage partners, leads, deals, products, pricing calculators, tasks, and
    more programmatically.


    All endpoints require authentication via API key. Use `Authorization: Bearer
    <api_key>` or `Api-Key <api_key>` header.


    See the [Authentication guide](/guides/authentication) for details.
  version: 1.0.0
servers:
  - url: https://api.journeybee.io/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: >-
      Authenticated company account info, API key permissions, and enabled
      modules
  - name: Analytics
    description: >-
      Dashboard analytics and reporting — commission, engagement, LMS, and
      partner revenue metrics
  - name: Assets
    description: File and media asset management
  - name: Attributions
    description: Attribution type definitions
  - name: Audit Log
    description: Unified audit log of company activity (read-only)
  - name: Automations
    description: Workflow automation rule configurations
  - name: Campaign Audience
    description: Audience filters on a campaign
  - name: Campaign Partners
    description: Partners shared into a campaign audience
  - name: Campaigns
    description: Partner marketing campaigns
  - name: Card Assignees
    description: Assigned users on a card
  - name: Card Partners
    description: Partners linked to a card
  - name: Card Tags
    description: Tags on a card
  - name: Cards
    description: Kanban project cards
  - name: Categories
    description: Partner categories
  - name: Certification Categories
    description: Categories on a certification
  - name: Certification Enrollments
    description: User enrollments in a certification
  - name: Certification Folders
    description: Folders on a certification
  - name: Certification Resources
    description: Curriculum resources in a certification
  - name: Certifications
    description: LMS certifications
  - name: Commissions
    description: >-
      Commission rule configurations with calculation entries,
      tier/category/partnership scoping
  - name: Contacts
    description: Partner contacts across partnerships
  - name: Currencies
    description: Available currencies
  - name: Custom Field Options
    description: Options on select/multi-select custom fields
  - name: Custom Field Rules
    description: Visibility and requirement rules on custom fields
  - name: Custom Field Values
    description: Custom field values
  - name: Custom Fields
    description: Custom field definitions
  - name: Deal Commission
    description: Commission calculation on a deal
  - name: Deal Custom Field Values
    description: Custom field values on a deal
  - name: Deal Notes
    description: Notes on a deal
  - name: Deal Payments
    description: Payment records on a deal (read-only)
  - name: Deal Products
    description: Products attached to a deal
  - name: Deal Stages
    description: Deal pipeline stages
  - name: Deal Tags
    description: Tags on a deal
  - name: Deal Tasks
    description: Tasks on a deal
  - name: Deals
    description: Deal management
  - name: Folders
    description: Content folders
  - name: Lead Attributions
    description: Attribution records on a lead
  - name: Lead Contacts
    description: Partner contacts on a lead
  - name: Lead Custom Field Values
    description: Custom field values on a lead
  - name: Lead Distributor
    description: Distributors for a lead
  - name: Lead Notes
    description: Notes on a lead
  - name: Lead Products
    description: Products attached to a lead
  - name: Lead Quotes
    description: >-
      Quotes on a lead — generated from pricing calculators with line items and
      totals
  - name: Lead Tags
    description: Tags on a lead
  - name: Lead Tasks
    description: Tasks on a lead
  - name: Lead Users
    description: Assigned users on a lead
  - name: Leads
    description: Lead management
  - name: Marketing Templates
    description: Marketing email templates
  - name: Partner Contacts
    description: Contacts on a partner
  - name: Partner Custom Field Values
    description: Custom field values on a partner
  - name: Partner Domains
    description: Domains on a partner
  - name: Partner Notes
    description: Notes on a partner
  - name: Partner Resellers
    description: Reseller assignments on a distributor
  - name: Partner Stages
    description: Partner pipeline stages
  - name: Partner Tags
    description: Tags on a partner
  - name: Partner Users
    description: Assigned users on a partner
  - name: Partners
    description: Core partner CRUD
  - name: Pricing Calculator Fields
    description: Input fields on a pricing calculator
  - name: Pricing Calculator Formulas
    description: Discount/tax/surcharge formulas on a pricing calculator
  - name: Pricing Calculator Products
    description: Products attached to a pricing calculator
  - name: Pricing Calculators
    description: Pricing calculator configurations
  - name: Products
    description: Product catalog
  - name: Resource Blocks
    description: Content blocks within a resource
  - name: Resource Categories
    description: Categories on a resource
  - name: Resource Folders
    description: Folders on a resource
  - name: Resource Tags
    description: Tags on a resource
  - name: Resources
    description: Learning resources
  - name: Room Blocks
    description: Content blocks within a room
  - name: Room Categories
    description: Category-based room access control
  - name: Room Partnerships
    description: Direct partnership room access
  - name: Room Stages
    description: Stage-based room access control
  - name: Room Tags
    description: Tag-based room access control
  - name: Room Tiers
    description: Tier-based room access control
  - name: Rooms
    description: Partner portal rooms
  - name: Tags
    description: Tag definitions
  - name: Task Users
    description: Assigned users on a task
  - name: Tasks
    description: Task management
  - name: Tiers
    description: Partner tiers
  - name: Users
    description: Company team members
  - name: Webhook Events
    description: Outbound webhook payloads sent to your configured URLs when events occur
paths:
  /pricing-calculators/:
    get:
      tags:
        - Pricing Calculators
      summary: List pricing calculators
      operationId: listPricingCalculators
      parameters:
        - schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            default: 25
            type: integer
            minimum: 1
            maximum: 100
          in: query
          name: per_page
          required: false
        - schema:
            type: string
            enum:
              - draft
              - live
              - archived
          in: query
          name: status
          required: false
        - schema:
            type: string
            maxLength: 200
          in: query
          name: search
          required: false
        - schema:
            type: string
            enum:
              - disabled
              - lead_only
              - lead_with_products
              - lead_with_quote
          in: query
          name: submission_mode
          required: false
        - schema:
            default: false
            type: boolean
          in: query
          name: include_archived
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        uuid:
                          type: string
                        name:
                          type: string
                        description:
                          anyOf:
                            - type: string
                            - type: 'null'
                        status:
                          type: string
                          enum:
                            - draft
                            - live
                            - archived
                        submission_mode:
                          type: string
                          enum:
                            - disabled
                            - lead_only
                            - lead_with_products
                            - lead_with_quote
                        display_settings:
                          type: object
                          properties:
                            showProductBreakdown:
                              description: Show individual product line items in the quote
                              type: boolean
                            showDiscounts:
                              description: Show discount/tax/surcharge line items
                              type: boolean
                            showRecurringTotal:
                              description: Show recurring payment totals
                              type: boolean
                            submitButtonText:
                              description: Custom submit button text
                              type: string
                            successMessage:
                              description: Message displayed after quote submission
                              type: string
                            billingMode:
                              description: >-
                                single: fixed billing period. switchable:
                                customer can choose monthly/quarterly/yearly.
                              type: string
                              enum:
                                - single
                                - switchable
                            billingPeriods:
                              description: Available periods when billingMode is switchable
                              type: array
                              items:
                                type: string
                                enum:
                                  - monthly
                                  - quarterly
                                  - yearly
                            defaultBillingPeriod:
                              description: Default selected billing period
                              type: string
                              enum:
                                - monthly
                                - quarterly
                                - yearly
                            periodDiscounts:
                              description: >-
                                Discounts per period. Example: { "yearly": 10 }
                                = 10% off yearly billing.
                              type: object
                              additionalProperties:
                                type: number
                          additionalProperties: false
                          description: >-
                            Display and billing configuration for the pricing
                            calculator.
                        currency:
                          type: object
                          properties:
                            uuid:
                              type: string
                            code:
                              type: string
                            label:
                              type: string
                          required:
                            - uuid
                            - code
                            - label
                          additionalProperties: false
                        fields_count:
                          type: number
                        products_count:
                          type: number
                        created_at:
                          type: string
                        updated_at:
                          type: string
                      required:
                        - uuid
                        - name
                        - description
                        - status
                        - submission_mode
                        - display_settings
                        - currency
                        - fields_count
                        - products_count
                        - created_at
                        - updated_at
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: number
                      per_page:
                        type: number
                      total:
                        type: number
                      total_pages:
                        type: number
                    required:
                      - page
                      - per_page
                      - total
                      - total_pages
                    additionalProperties: false
                required:
                  - data
                  - pagination
                additionalProperties: false
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

````