> ## 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. # Preview a pricing calculator without saving a quote ## OpenAPI ````yaml /openapi.json post /pricing-calculators/{uuid}/preview 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 ` or `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: Integrations description: Company integration settings - 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/{uuid}/preview: post: tags: - Pricing Calculators summary: Preview a pricing calculator without saving a quote operationId: previewPricingCalculator parameters: - schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: path name: uuid required: true requestBody: required: true content: application/json: schema: type: object properties: field_values: type: object additionalProperties: anyOf: - type: integer minimum: -1000000 maximum: 1000000 - type: string maxLength: 1000 - type: boolean selected_optional_products: maxItems: 100 type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ optional_product_quantities: type: object additionalProperties: type: integer exclusiveMinimum: 0 maximum: 100000 required: - field_values additionalProperties: false description: >- Inputs and optional calculator-product membership UUID selections used to preview a pricing calculator without saving a quote. description: >- Inputs and optional calculator-product membership UUID selections used to preview a pricing calculator without saving a quote. responses: '200': description: >- Calculated totals, adjustments, and presentation for a pricing calculator preview. Product and formula references are public UUIDs. content: application/json: schema: type: object properties: line_items: type: array items: type: object properties: product_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ product_name: type: string product_sku: anyOf: - type: string - type: 'null' quantity: type: number unit_price: anyOf: - type: number - type: 'null' subtotal: anyOf: - type: number - type: 'null' billing_type: type: string enum: - one_time - recurring billing_period: anyOf: - type: string enum: - monthly - quarterly - yearly - type: 'null' required: - product_id - product_name - product_sku - quantity - unit_price - subtotal - billing_type - billing_period additionalProperties: false selected_optional_products: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ subtotal: type: number adjustments: type: array items: type: object properties: name: type: string formula_id: type: string amount: type: number recurring_amount: type: number type: type: string enum: - discount - tax - surcharge billing_type: type: string enum: - one_time - recurring detail: anyOf: - oneOf: - type: object properties: kind: type: string enum: - percentage percentage: type: number base: type: number base_kind: type: string enum: - subtotal - running_total - selected_sources amount: type: number signed_one_time_amount: type: number signed_recurring_amount: type: number presentation: type: object properties: group_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' group_label: anyOf: - type: string - type: 'null' visibility: type: string enum: - visible - hidden sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 target_product_uuid: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' additionalProperties: false required: - kind - percentage - base - base_kind - amount additionalProperties: false - type: object properties: kind: type: string enum: - fixed amount: type: number signed_one_time_amount: type: number signed_recurring_amount: type: number presentation: type: object properties: group_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' group_label: anyOf: - type: string - type: 'null' visibility: type: string enum: - visible - hidden sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 target_product_uuid: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' additionalProperties: false required: - kind - amount additionalProperties: false - type: object properties: kind: type: string enum: - formula branch: type: string enum: - when_true - when_false term: anyOf: - oneOf: - type: object properties: kind: type: string enum: - flat amount: type: number required: - kind - amount additionalProperties: false - type: object properties: kind: type: string enum: - per_unit rate: type: number quantity: type: number variable_name: type: string required: - kind - rate - quantity - variable_name additionalProperties: false - type: 'null' amount: type: number signed_one_time_amount: type: number signed_recurring_amount: type: number presentation: type: object properties: group_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' group_label: anyOf: - type: string - type: 'null' visibility: type: string enum: - visible - hidden sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 target_product_uuid: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' additionalProperties: false required: - kind - branch - term - amount additionalProperties: false - type: 'null' required: - name - formula_id - amount - type additionalProperties: false total: type: number recurring_total: type: number required: - line_items - selected_optional_products - subtotal - adjustments - total additionalProperties: false description: >- Calculated totals, adjustments, and presentation for a pricing calculator preview. Product and formula references are public UUIDs. components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````