Skip to main content
POST
/
pricing-calculators
/
Create a pricing calculator
curl --request POST \
  --url https://api.journeybee.io/v1/pricing-calculators/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_settings": {},
  "submission_mode": "disabled",
  "description": "<string>",
  "currency_uuid": "<string>"
}
'
{
  "uuid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "display_settings": {
    "showProductBreakdown": true,
    "showDiscounts": true,
    "showRecurringTotal": true,
    "submitButtonText": "<string>",
    "successMessage": "<string>",
    "billingPeriods": [],
    "periodDiscounts": {}
  },
  "currency": {
    "uuid": "<string>",
    "code": "<string>",
    "label": "<string>"
  },
  "fields_count": 123,
  "products_count": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "fields": [
    {
      "uuid": "<string>",
      "label": "<string>",
      "variable_name": "<string>",
      "required": true,
      "sort_order": 123,
      "field_config": {
        "min": 123,
        "max": 123,
        "step": 123,
        "default": 123,
        "options": [
          {
            "value": "<string>",
            "label": "<string>",
            "priceModifier": 123
          }
        ],
        "defaultChecked": true
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "products": [
    {
      "uuid": "<string>",
      "sort_order": 123,
      "quantity_fixed": 123,
      "quantity_variable_name": "<string>",
      "quantity_condition": "<string>",
      "quantity_if_true": 123,
      "quantity_if_false": 123,
      "price_override": 123,
      "is_optional": true,
      "is_included_by_default": true,
      "product": {
        "uuid": "<string>",
        "name": "<string>",
        "sku": "<string>",
        "price": 123,
        "currency_code": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "formulas": [
    {
      "uuid": "<string>",
      "name": "<string>",
      "condition": "<string>",
      "value": 123,
      "sort_order": 123,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
name
string
required

Calculator name

display_settings
object
required

Display and billing configuration for the pricing calculator.

submission_mode
enum<string>
default:disabled
required
Available options:
disabled,
lead_only,
lead_with_products,
lead_with_quote
description
string | null

Calculator description

currency_uuid
string

Response

201 - application/json

Default Response

uuid
string
required
name
string
required
description
string | null
required
status
enum<string>
required
Available options:
draft,
live,
archived
submission_mode
enum<string>
required
Available options:
disabled,
lead_only,
lead_with_products,
lead_with_quote
display_settings
object
required

Display and billing configuration for the pricing calculator.

currency
object
required
fields_count
number
required
products_count
number
required
created_at
string
required
updated_at
string
required
fields
object[]
required
products
object[]
required
formulas
object[]
required