Sign in

v1

latestOpenAPI 3.0.32026-07-12254440.6 KB
Price

createPrice

Create a new price entity

post/v1/price

Request body

_schema'price'
activeboolean required

Whether the price can be used for new purchases.

descriptionstring

A brief description of the price.

long_descriptionstring

A detailed description of the price. This is shown on the order document and order table. Multi-line supported.

type'one_time' | 'recurring' required

One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

pricing_model'per_unit' | 'tiered_volume' | 'tiered_graduated' | 'tiered_flatfee'

Describes how to compute the price per period. Either per_unit, tiered_graduated or tiered_volume.

  • per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
  • tiered_graduated indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
  • tiered_volume indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
  • tiered_flatfee While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
unit_amountnumber

The unit amount in cents to be charged, represented as a whole integer if possible.

unit_amount_decimalstring

The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.

unit_amount_currencystring

Three-letter ISO currency code, in lowercase. Must be a supported currency. ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html

is_composite_priceboolean

The flag for prices that contain price components.

is_tax_inclusiveboolean

Specifies whether the price is considered inclusive of taxes or not.

price_display_in_journeys'show_price' | 'show_as_starting_price' | 'show_as_on_request'

Defines the way the price amount is display in epilot journeys.

billing_duration_amountnumber

The billing period duration

billing_duration_unit'weeks' | 'months' | 'years' | 'null' nullable

The billing period duration unit

notice_time_amountnumber

The notice period duration

notice_time_unit'weeks' | 'months' | 'years' | 'null' nullable

The notice period duration unit

termination_time_amountnumber

The termination period duration

termination_time_unit'weeks' | 'months' | 'years' | 'null' nullable

The termination period duration unit

renewal_duration_amountnumber

The renewal period duration

renewal_duration_unit'weeks' | 'months' | 'years' | 'null' nullable

The renewal period duration unit

variable_priceboolean

The flag for prices that can be influenced by external variables such as user input.

unitstring

The unit of measurement used for display purposes and possibly for calculations when the price is variable.

_tagsstring[] nullable
_purposestring[] nullable
_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example request

{
  "unit_amount_currency": "EUR",
  "tax": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}

Response

Price entity with id

_idstring uuid
_schema'price' required
_orgstring required

Organization Id the entity belongs to

_tagsstring[] nullable
_titlestring
_created_atstring date-time
_updated_atstring date-time
activeboolean required

Whether the price can be used for new purchases.

descriptionstring

A brief description of the price.

long_descriptionstring

A detailed description of the price. This is shown on the order document and order table. Multi-line supported.

type'one_time' | 'recurring' required

One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

pricing_model'per_unit' | 'tiered_volume' | 'tiered_graduated' | 'tiered_flatfee'

Describes how to compute the price per period. Either per_unit, tiered_graduated or tiered_volume.

  • per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
  • tiered_graduated indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
  • tiered_volume indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
  • tiered_flatfee While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
unit_amountnumber

The unit amount in cents to be charged, represented as a whole integer if possible.

unit_amount_decimalstring

The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.

unit_amount_currencystring

Three-letter ISO currency code, in lowercase. Must be a supported currency. ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html

is_composite_priceboolean

The flag for prices that contain price components.

is_tax_inclusiveboolean

Specifies whether the price is considered inclusive of taxes or not.

price_display_in_journeys'show_price' | 'show_as_starting_price' | 'show_as_on_request'

Defines the way the price amount is display in epilot journeys.

billing_duration_amountnumber

The billing period duration

billing_duration_unit'weeks' | 'months' | 'years' | 'null' nullable

The billing period duration unit

notice_time_amountnumber

The notice period duration

notice_time_unit'weeks' | 'months' | 'years' | 'null' nullable

The notice period duration unit

termination_time_amountnumber

The termination period duration

termination_time_unit'weeks' | 'months' | 'years' | 'null' nullable

The termination period duration unit

renewal_duration_amountnumber

The renewal period duration

renewal_duration_unit'weeks' | 'months' | 'years' | 'null' nullable

The renewal period duration unit

variable_priceboolean

The flag for prices that can be influenced by external variables such as user input.

unitstring

The unit of measurement used for display purposes and possibly for calculations when the price is variable.

_purposestring[] nullable
_manifeststring[]

Manifest ID used to create/update the entity

__additionalobject nullable

Additional fields that are not part of the schema

Example response

{
  "_id": "123e4567-e89b-12d3-a456-426614174000",
  "_files": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_acl": {
    "view": [
      "org:456"
    ],
    "edit": [
      "org:456"
    ],
    "delete": [
      "org:456"
    ]
  },
  "unit_amount_currency": "EUR",
  "tax": {
    "$relation": [
      {
        "entity_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "__additional": {}
}