---
title: "patchPrice"
method: PATCH
path: "/v1/price/{priceId}"
tags: ["Price"]
---

# patchPrice

`PATCH /v1/price/{priceId}`

Partially update a specific price entity's properties by a given id and a given payload

## Path parameters

- `priceId` string, uuid, required

## Request body

- PricePatch
  - `_schema` 'price'
  - `active` boolean — Whether the price can be used for new purchases.
  - `description` string — A brief description of the price.
  - `long_description` string — A detailed description of the price. This is shown on the order document and order table. Multi-line supported.
  - `type` 'one_time' | 'recurring' — 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.
  - `price_components` object — A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
    - `$relation` PriceComponentRelation[], required
      - `entity_id` string — The id of the price component
      - `_tags` string[] — An arbitrary set of tags attached to the composite price - component relation
  - `unit_amount` number — The unit amount in cents to be charged, represented as a whole integer if possible.
  - `unit_amount_decimal` string — The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
  - `unit_amount_currency` string — 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_price` boolean — The flag for prices that contain price components.
  - `tiers` PriceTier[] — Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
    - `up_to` number, nullable
    - `flat_fee_amount` number
    - `flat_fee_amount_decimal` string
    - `unit_amount` number
    - `unit_amount_decimal` string
    - `display_mode` 'hidden' | 'on_request'
  - `is_tax_inclusive` boolean — 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_amount` number — The billing period duration
  - `billing_duration_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The billing period duration unit
  - `notice_time_amount` number — The notice period duration
  - `notice_time_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The notice period duration unit
  - `termination_time_amount` number — The termination period duration
  - `termination_time_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The termination period duration unit
  - `renewal_duration_amount` number — The renewal period duration
  - `renewal_duration_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The renewal period duration unit
  - `variable_price` boolean — The flag for prices that can be influenced by external variables such as user input.
  - `unit` string — The unit of measurement used for display purposes and possibly for calculations when the price is variable.
  - `tax` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_tags` string[], nullable
  - `_purpose` string[], nullable
  - `_files` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_manifest` string[] — Manifest ID used to create/update the entity
  - `__additional` object, nullable — Additional fields that are not part of the schema

## Response `200`

Price entity with id

- Price
  - `_id` string, uuid
  - `_schema` 'price', required
  - `_org` string, required — Organization Id the entity belongs to
  - `_tags` string[], nullable
  - `_files` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_owners` BaseEntityOwner[]
    - `org_id` string, required
    - `user_id` string
  - `_title` string
  - `_created_at` string, date-time
  - `_updated_at` string, date-time
  - `_acl` BaseEntityAcl — Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
    - `view` string[]
    - `edit` string[]
    - `delete` string[]
  - `active` boolean, required — Whether the price can be used for new purchases.
  - `description` string — A brief description of the price.
  - `long_description` string — 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.
  - `price_components` object — A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
    - `$relation` PriceComponentRelation[], required
      - `entity_id` string — The id of the price component
      - `_tags` string[] — An arbitrary set of tags attached to the composite price - component relation
  - `unit_amount` number — The unit amount in cents to be charged, represented as a whole integer if possible.
  - `unit_amount_decimal` string — The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
  - `unit_amount_currency` string — 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_price` boolean — The flag for prices that contain price components.
  - `tiers` PriceTier[] — Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
    - `up_to` number, nullable
    - `flat_fee_amount` number
    - `flat_fee_amount_decimal` string
    - `unit_amount` number
    - `unit_amount_decimal` string
    - `display_mode` 'hidden' | 'on_request'
  - `is_tax_inclusive` boolean — 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_amount` number — The billing period duration
  - `billing_duration_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The billing period duration unit
  - `notice_time_amount` number — The notice period duration
  - `notice_time_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The notice period duration unit
  - `termination_time_amount` number — The termination period duration
  - `termination_time_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The termination period duration unit
  - `renewal_duration_amount` number — The renewal period duration
  - `renewal_duration_unit` 'weeks' | 'months' | 'years' | 'null', nullable — The renewal period duration unit
  - `variable_price` boolean — The flag for prices that can be influenced by external variables such as user input.
  - `unit` string — The unit of measurement used for display purposes and possibly for calculations when the price is variable.
  - `tax` BaseRelation
    - `$relation` object[], required
      - `entity_id` string, uuid
      - `_tags` string[], nullable
  - `_purpose` string[], nullable
  - `_manifest` string[] — Manifest ID used to create/update the entity
  - `__additional` object, nullable — Additional fields that are not part of the schema

## Other responses

- `400` — Any error based on client data errors
- `500` — Any error based on the server-side

---

[API](https://skmtc.dev/epilot/apis/product-api.md) · [All operations](https://skmtc.dev/epilot/apis/product-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/epilot/product-api/revisions/246cfb2edf7f/schema)