> ## 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. # Update a pricing calculator ## OpenAPI ````yaml /openapi.json patch /pricing-calculators/{uuid} 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: 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}: patch: tags: - Pricing Calculators summary: Update a pricing calculator operationId: updatePricingCalculator 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: name: type: string description: anyOf: - type: string - type: 'null' status: type: string enum: - draft - live - archived currency_uuid: type: string 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. submission_mode: type: string enum: - disabled - lead_only - lead_with_products - lead_with_quote additionalProperties: false responses: '200': description: Default Response content: application/json: schema: 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 fields: type: array items: type: object properties: uuid: type: string label: type: string field_type: type: string enum: - number - dropdown - checkbox variable_name: type: string required: type: boolean sort_order: type: number field_config: type: object properties: min: description: Minimum value (number/slider fields) type: number max: description: Maximum value (number/slider fields) type: number step: description: Step increment (number/slider fields) type: number default: description: Default value type: number options: description: Choices for dropdown/radio fields type: array items: type: object properties: value: type: string description: Option value label: type: string description: Display label priceModifier: description: Price adjustment when selected type: number required: - value - label additionalProperties: false defaultChecked: description: Default state for checkbox fields type: boolean additionalProperties: false description: >- Field-type-specific config. number/slider: min/max/step/default. dropdown/radio: options. checkbox: defaultChecked. created_at: type: string updated_at: type: string required: - uuid - label - field_type - variable_name - required - sort_order - field_config - created_at - updated_at additionalProperties: false products: type: array items: type: object properties: uuid: type: string sort_order: type: number quantity_type: type: string enum: - fixed - variable - conditional quantity_fixed: anyOf: - type: number - type: 'null' quantity_variable_name: anyOf: - type: string - type: 'null' quantity_condition: anyOf: - type: string - type: 'null' quantity_if_true: anyOf: - type: number - type: 'null' quantity_if_false: anyOf: - type: number - type: 'null' price_override: anyOf: - type: number - type: 'null' description: >- Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is. is_optional: type: boolean is_included_by_default: type: boolean quantity_editable: type: boolean anchor_field_id: anyOf: - type: number - type: 'null' product: type: object properties: uuid: type: string name: type: string sku: anyOf: - type: string - type: 'null' price: type: number description: >- Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is. billing_type: type: string enum: - one_time - recurring billing_period: anyOf: - type: string enum: - monthly - quarterly - yearly - type: 'null' currency_code: type: string required: - uuid - name - sku - price - billing_type - billing_period - currency_code additionalProperties: false created_at: type: string updated_at: type: string required: - uuid - sort_order - quantity_type - quantity_fixed - quantity_variable_name - quantity_condition - quantity_if_true - quantity_if_false - price_override - is_optional - is_included_by_default - quantity_editable - anchor_field_id - product - created_at - updated_at additionalProperties: false formulas: type: array items: type: object properties: uuid: type: string formula_type: type: string enum: - discount - tax - surcharge name: type: string condition: anyOf: - type: string - type: 'null' calculation_type: type: string enum: - fixed - percentage - formula value: anyOf: - type: number - type: 'null' formula_config: description: >- Structured amount config used when calculation_type is "formula". anyOf: - type: object properties: condition: anyOf: - type: object properties: variable_name: type: string maxLength: 100 operator: type: string enum: - '>=' - <= - '>' - < - '==' - '!=' value: type: string maxLength: 200 required: - variable_name - operator - value additionalProperties: false - type: 'null' when_true: oneOf: - type: object properties: mode: type: string enum: - flat amount: type: integer minimum: 0 maximum: 9007199254740991 required: - mode - amount additionalProperties: false - type: object properties: mode: type: string enum: - per_unit variable_name: type: string maxLength: 100 rate: type: integer minimum: 0 maximum: 9007199254740991 required: - mode - variable_name - rate additionalProperties: false when_false: anyOf: - oneOf: - type: object properties: mode: type: string enum: - flat amount: type: integer minimum: 0 maximum: 9007199254740991 required: - mode - amount additionalProperties: false - type: object properties: mode: type: string enum: - per_unit variable_name: type: string maxLength: 100 rate: type: integer minimum: 0 maximum: 9007199254740991 required: - mode - variable_name - rate additionalProperties: false - type: 'null' no_charge_when_zero: type: boolean required: - condition - when_true - when_false additionalProperties: false - type: 'null' billing_type: type: string enum: - one_time - recurring percentage_base: type: string enum: - subtotal - running_total selected_product_uuid: anyOf: - type: string - type: 'null' sort_order: type: number created_at: type: string updated_at: type: string required: - uuid - formula_type - name - condition - calculation_type - value - formula_config - billing_type - percentage_base - selected_product_uuid - sort_order - created_at - updated_at additionalProperties: false required: - uuid - name - description - status - submission_mode - display_settings - currency - fields_count - products_count - created_at - updated_at - fields - products - formulas additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````