@epilot/pricing-client 3.33.2 → 3.35.0

package/dist/openapi.d.ts

@@ -240,15 +240,162 @@ declare namespace Components {
              * Total amount before discount is applied as a string with all the decimal places.
              */
             before_discount_amount_total_decimal?: string;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            /**
+             * The quantity of products being purchased.
+             */
+            quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
+            price_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "value": 1000.245,
+             *     "name": "avg consumption",
+             *     "metadata": {
+             *       "journey_title": "energy journey",
+             *       "step_name": "avg consumption picker"
+             *     }
+             *   }
+             * ]
+             */
+            PriceInputMappings;
+            /**
+             * Specifies whether the price is considered `inclusive` of taxes or not.
+             */
+            is_tax_inclusive?: boolean;
+            /**
+             * The snapshot of the product.
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            _product?: {
+                [name: string]: any;
+                /**
+                 * The description for the product
+                 */
+                description?: string;
+                /**
+                 * The product code
+                 */
+                code?: string;
+                /**
+                 * The type of Product:
+                 *
+                 * | type | description |
+                 * |----| ----|
+                 * | `product` | Represents a physical good |
+                 * | `service` | Represents a service or virtual product |
+                 *
+                 */
+                type?: "product" | "service";
+                /**
+                 * The product main name
+                 */
+                name?: string;
+                feature?: {
+                    /**
+                     * An arbitrary set of tags attached to a feature
+                     */
+                    _tags?: string[];
+                    feature?: string;
+                }[];
+                /**
+                 * Stores references to products that can be cross sold with the current product.
+                 */
+                cross_sellable_products?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of file images of the product
+                 */
+                product_images?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of files downloadable from the product.
+                 * e.g: tech specifications, quality control sheets, privacy policy agreements
+                 *
+                 */
+                product_downloads?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * A set of [prices](/api/pricing#tag/simple_price_schema) or [composite prices](/api/pricing#tag/dynamic_price_schema) for the current product.
+                 */
+                price_options?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to the availability files that define where this product is available.
+                 * These files are used when interacting with products via epilot Journeys, thought the AvailabilityCheck block.
+                 *
+                 */
+                _availability_files?: File[];
+                /**
+                 * The product id
+                 */
+                _id?: string;
+                /**
+                 * The autogenerated product title
+                 */
+                _title?: string;
+                /**
+                 * The organization id the product belongs to
+                 */
+                _org_id?: string;
+                /**
+                 * The product creation date
+                 */
+                _created_at?: string;
+                /**
+                 * The product last update date
+                 */
+                _updated_at?: string;
+            };
             /**
              * price item id
              */
             _id?: string;
-            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
             /**
              * The unit amount value
              */
             unit_amount?: number;
+            /**
+             * The unit amount before any discount is applied
+             */
+            before_discount_unit_amount?: number;
+            /**
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             */
+            unit_amount_decimal?: string;
+            /**
+             * The discount amount applied for each unit
+             */
+            unit_discount_amount?: number;
+            /**
+             * The discount amount applied for each unit represented as a decimal string
+             */
+            unit_discount_amount_decimal?: string;
             /**
              * The unit gross amount value.
              */
@@ -257,10 +404,6 @@ declare namespace Components {
              * The unit gross amount value.
              */
             unit_amount_gross_decimal?: string;
-            /**
-             * Total tax amount for this line item.
-             */
-            amount_tax?: number;
             /**
              * Net unit amount without taxes or discounts.
              */
@@ -270,37 +413,41 @@ declare namespace Components {
              */
             unit_amount_net_decimal?: string;
             /**
-             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             * The net discount amount applied for each unit
              */
-            unit_amount_decimal?: string;
-            currency?: /**
-             * 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
-             *
-             * example:
-             * EUR
+            unit_discount_amount_net?: number;
+            /**
+             * The net discount amount applied for each unit represented as a decimal string
              */
-            Currency;
+            unit_discount_amount_net_decimal?: string;
             /**
-             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             * The discount amount applied to the tax
              */
-            description?: string;
+            tax_discount_amount?: number;
             /**
-             * The quantity of products being purchased.
+             * The discount amount applied to the tax represented as a decimal string
              */
-            quantity?: number;
+            tax_discount_amount_decimal?: string;
             /**
-             * The id of the product.
+             * Total tax amount for this line item.
              */
-            product_id?: string;
+            amount_tax?: number;
             /**
-             * The id of the price.
+             * The tax amount before any discount is applied
              */
-            price_id?: string;
+            before_discount_tax_amount?: number;
             /**
-             * The flag for prices that contain price components.
+             * The tax amount before any discount is applied represented as a decimal string
              */
-            is_composite_price?: boolean;
+            before_discount_tax_amount_decimal?: string;
+            currency?: /**
+             * 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
+             *
+             * example:
+             * EUR
+             */
+            Currency;
             /**
              * The price snapshot data.
              */
@@ -319,14 +466,6 @@ declare namespace Components {
              * }
              */
             CompositePrice;
-            _product?: /**
-             * The product entity
-             * example:
-             * {
-             *   "$ref": "#/components/examples/product"
-             * }
-             */
-            Product;
             /**
              * The taxes applied to the price item.
              */
@@ -335,40 +474,36 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-            price_mappings?: /**
-             * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "value": 1000.245,
-             *     "name": "avg consumption",
-             *     "metadata": {
-             *       "journey_title": "energy journey",
-             *       "step_name": "avg consumption picker"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
             /**
              * When set to true on a `_price` displayed as OnRequest (`show_as_on_request: 'on_request'`) this flag means the price has been approved and can now be displayed to the customer. This flag is only valid for prices shown as 'on_request'.
              */
             on_request_approved?: boolean;
-            /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
-             */
-            is_tax_inclusive?: boolean;
         }
         /**
-         * Represents a valid base price item from a client.
+         * Represents the common keys in BasePriceItem and BasePriceItemDto
          */
-        export interface BasePriceItemDto {
+        export interface BasePriceItemCommon {
             metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
             /**
              * The quantity of products being purchased.
              */
             quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
             /**
              * Price mapping information required to compute totals
              */
@@ -389,28 +524,110 @@ declare namespace Components {
              */
             PriceInputMappings;
             /**
-             * External fees mapping information required to compute totals, for some pricing models
-             */
-            external_fees_mappings?: /**
-             * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * Specifies whether the price is considered `inclusive` of taxes or not.
              */
-            ExternalFeeMappings;
+            is_tax_inclusive?: boolean;
             /**
-             * External fees metadata information required to compute totals, for some pricing models
+             * The snapshot of the product.
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
              */
-            external_fees_metadata?: ExternalFeeMetadata;
+            _product?: {
+                [name: string]: any;
+                /**
+                 * The description for the product
+                 */
+                description?: string;
+                /**
+                 * The product code
+                 */
+                code?: string;
+                /**
+                 * The type of Product:
+                 *
+                 * | type | description |
+                 * |----| ----|
+                 * | `product` | Represents a physical good |
+                 * | `service` | Represents a service or virtual product |
+                 *
+                 */
+                type?: "product" | "service";
+                /**
+                 * The product main name
+                 */
+                name?: string;
+                feature?: {
+                    /**
+                     * An arbitrary set of tags attached to a feature
+                     */
+                    _tags?: string[];
+                    feature?: string;
+                }[];
+                /**
+                 * Stores references to products that can be cross sold with the current product.
+                 */
+                cross_sellable_products?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of file images of the product
+                 */
+                product_images?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of files downloadable from the product.
+                 * e.g: tech specifications, quality control sheets, privacy policy agreements
+                 *
+                 */
+                product_downloads?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * A set of [prices](/api/pricing#tag/simple_price_schema) or [composite prices](/api/pricing#tag/dynamic_price_schema) for the current product.
+                 */
+                price_options?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to the availability files that define where this product is available.
+                 * These files are used when interacting with products via epilot Journeys, thought the AvailabilityCheck block.
+                 *
+                 */
+                _availability_files?: File[];
+                /**
+                 * The product id
+                 */
+                _id?: string;
+                /**
+                 * The autogenerated product title
+                 */
+                _title?: string;
+                /**
+                 * The organization id the product belongs to
+                 */
+                _org_id?: string;
+                /**
+                 * The product creation date
+                 */
+                _created_at?: string;
+                /**
+                 * The product last update date
+                 */
+                _updated_at?: string;
+            };
+        }
+        /**
+         * Represents a valid base price item from a client.
+         */
+        export interface BasePriceItemDto {
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
             /**
-             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             * The quantity of products being purchased.
              */
-            description?: string;
+            quantity?: number;
             /**
              * The id of the product.
              */
@@ -420,21 +637,33 @@ declare namespace Components {
              */
             price_id?: string;
             /**
-             * The ids of the coupons applicable to the price item
+             * The flag for prices that contain price components.
              */
-            coupon_ids?: string[];
+            is_composite_price?: boolean;
             /**
-             * The taxes applied to the price item.
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
-            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
-            /**
-             * The taxes applied to the price item.
+            description?: string;
+            price_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "value": 1000.245,
+             *     "name": "avg consumption",
+             *     "metadata": {
+             *       "journey_title": "energy journey",
+             *       "step_name": "avg consumption picker"
+             *     }
+             *   }
+             * ]
              */
-            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
+            PriceInputMappings;
             /**
-             * The flag for prices that contain price components.
+             * Specifies whether the price is considered `inclusive` of taxes or not.
              */
-            is_composite_price?: boolean;
+            is_tax_inclusive?: boolean;
             /**
              * The snapshot of the product.
              * example:
@@ -526,6 +755,31 @@ declare namespace Components {
                  */
                 _updated_at?: string;
             };
+            external_fees_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "amount_total": 1000,
+             *     "amount_total_decimal": "10.00"
+             *   }
+             * ]
+             */
+            ExternalFeeMappings;
+            external_fees_metadata?: ExternalFeeMetadata;
+            /**
+             * The ids of the coupons applicable to the price item
+             */
+            coupon_ids?: string[];
+            /**
+             * The taxes applied to the price item.
+             */
+            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
+            /**
+             * The taxes applied to the price item.
+             */
+            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
             /**
              * The coupons applicable to the price item
              */
@@ -560,10 +814,6 @@ declare namespace Components {
              * }
              */
             Coupon)[];
-            /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
-             */
-            is_tax_inclusive?: boolean;
         }
         /**
          * The basic auth credentials
@@ -914,40 +1164,187 @@ declare namespace Components {
             /**
              * Total of all items after (discounts and) taxes are applied.
              */
-            amount_total?: number;
+            amount_total?: number;
+            /**
+             * Total of all items after (discounts and) taxes are applied, as a string with all the decimal places.
+             */
+            amount_total_decimal?: string;
+            /**
+             * The discount amount.
+             */
+            discount_amount?: number;
+            /**
+             * The discount amount as a string with all the decimal places.
+             */
+            discount_amount_decimal?: string;
+            /**
+             * The discount percentage, if the applied coupon had a percentage type.
+             */
+            discount_percentage?: number;
+            /**
+             * Total amount before discount is applied.
+             */
+            before_discount_amount_total?: number;
+            /**
+             * Total amount before discount is applied as a string with all the decimal places.
+             */
+            before_discount_amount_total_decimal?: string;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            /**
+             * The quantity of products being purchased.
+             */
+            quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
+            price_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "value": 1000.245,
+             *     "name": "avg consumption",
+             *     "metadata": {
+             *       "journey_title": "energy journey",
+             *       "step_name": "avg consumption picker"
+             *     }
+             *   }
+             * ]
+             */
+            PriceInputMappings;
             /**
-             * Total of all items after (discounts and) taxes are applied, as a string with all the decimal places.
+             * Specifies whether the price is considered `inclusive` of taxes or not.
              */
-            amount_total_decimal?: string;
+            is_tax_inclusive?: boolean;
             /**
-             * The discount amount.
+             * The snapshot of the product.
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
              */
-            discount_amount?: number;
+            _product?: {
+                [name: string]: any;
+                /**
+                 * The description for the product
+                 */
+                description?: string;
+                /**
+                 * The product code
+                 */
+                code?: string;
+                /**
+                 * The type of Product:
+                 *
+                 * | type | description |
+                 * |----| ----|
+                 * | `product` | Represents a physical good |
+                 * | `service` | Represents a service or virtual product |
+                 *
+                 */
+                type?: "product" | "service";
+                /**
+                 * The product main name
+                 */
+                name?: string;
+                feature?: {
+                    /**
+                     * An arbitrary set of tags attached to a feature
+                     */
+                    _tags?: string[];
+                    feature?: string;
+                }[];
+                /**
+                 * Stores references to products that can be cross sold with the current product.
+                 */
+                cross_sellable_products?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of file images of the product
+                 */
+                product_images?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of files downloadable from the product.
+                 * e.g: tech specifications, quality control sheets, privacy policy agreements
+                 *
+                 */
+                product_downloads?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * A set of [prices](/api/pricing#tag/simple_price_schema) or [composite prices](/api/pricing#tag/dynamic_price_schema) for the current product.
+                 */
+                price_options?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to the availability files that define where this product is available.
+                 * These files are used when interacting with products via epilot Journeys, thought the AvailabilityCheck block.
+                 *
+                 */
+                _availability_files?: File[];
+                /**
+                 * The product id
+                 */
+                _id?: string;
+                /**
+                 * The autogenerated product title
+                 */
+                _title?: string;
+                /**
+                 * The organization id the product belongs to
+                 */
+                _org_id?: string;
+                /**
+                 * The product creation date
+                 */
+                _created_at?: string;
+                /**
+                 * The product last update date
+                 */
+                _updated_at?: string;
+            };
             /**
-             * The discount amount as a string with all the decimal places.
+             * price item id
              */
-            discount_amount_decimal?: string;
+            _id?: string;
             /**
-             * The discount percentage, if the applied coupon had a percentage type.
+             * The unit amount value
              */
-            discount_percentage?: number;
+            unit_amount?: number;
             /**
-             * Total amount before discount is applied.
+             * The unit amount before any discount is applied
              */
-            before_discount_amount_total?: number;
+            before_discount_unit_amount?: number;
             /**
-             * Total amount before discount is applied as a string with all the decimal places.
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
              */
-            before_discount_amount_total_decimal?: string;
+            unit_amount_decimal?: string;
             /**
-             * price item id
+             * The discount amount applied for each unit
              */
-            _id?: string;
-            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            unit_discount_amount?: number;
             /**
-             * The unit amount value
+             * The discount amount applied for each unit represented as a decimal string
              */
-            unit_amount?: number;
+            unit_discount_amount_decimal?: string;
             /**
              * The unit gross amount value.
              */
@@ -956,10 +1353,6 @@ declare namespace Components {
              * The unit gross amount value.
              */
             unit_amount_gross_decimal?: string;
-            /**
-             * Total tax amount for this line item.
-             */
-            amount_tax?: number;
             /**
              * Net unit amount without taxes or discounts.
              */
@@ -969,37 +1362,41 @@ declare namespace Components {
              */
             unit_amount_net_decimal?: string;
             /**
-             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             * The net discount amount applied for each unit
              */
-            unit_amount_decimal?: string;
-            currency?: /**
-             * 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
-             *
-             * example:
-             * EUR
+            unit_discount_amount_net?: number;
+            /**
+             * The net discount amount applied for each unit represented as a decimal string
              */
-            Currency;
+            unit_discount_amount_net_decimal?: string;
             /**
-             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             * The discount amount applied to the tax
              */
-            description?: string;
+            tax_discount_amount?: number;
             /**
-             * The quantity of products being purchased.
+             * The discount amount applied to the tax represented as a decimal string
              */
-            quantity?: number;
+            tax_discount_amount_decimal?: string;
             /**
-             * The id of the product.
+             * Total tax amount for this line item.
              */
-            product_id?: string;
+            amount_tax?: number;
             /**
-             * The id of the price.
+             * The tax amount before any discount is applied
              */
-            price_id?: string;
+            before_discount_tax_amount?: number;
             /**
-             * The flag for prices that contain price components.
+             * The tax amount before any discount is applied represented as a decimal string
              */
-            is_composite_price?: boolean;
+            before_discount_tax_amount_decimal?: string;
+            currency?: /**
+             * 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
+             *
+             * example:
+             * EUR
+             */
+            Currency;
             /**
              * The price snapshot data.
              */
@@ -1018,14 +1415,6 @@ declare namespace Components {
              * }
              */
             CompositePrice;
-            _product?: /**
-             * The product entity
-             * example:
-             * {
-             *   "$ref": "#/components/examples/product"
-             * }
-             */
-            Product;
             /**
              * The taxes applied to the price item.
              */
@@ -1034,30 +1423,10 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-            price_mappings?: /**
-             * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "value": 1000.245,
-             *     "name": "avg consumption",
-             *     "metadata": {
-             *       "journey_title": "energy journey",
-             *       "step_name": "avg consumption picker"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
             /**
              * When set to true on a `_price` displayed as OnRequest (`show_as_on_request: 'on_request'`) this flag means the price has been approved and can now be displayed to the customer. This flag is only valid for prices shown as 'on_request'.
              */
             on_request_approved?: boolean;
-            /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
-             */
-            is_tax_inclusive?: boolean;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -1080,6 +1449,22 @@ declare namespace Components {
              * The quantity of products being purchased.
              */
             quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -1096,47 +1481,10 @@ declare namespace Components {
              * ]
              */
             PriceInputMappings;
-            external_fees_mappings?: /**
-             * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
-             */
-            ExternalFeeMappings;
-            external_fees_metadata?: ExternalFeeMetadata;
-            /**
-             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
-             */
-            description?: string;
-            /**
-             * The id of the product.
-             */
-            product_id?: string;
-            /**
-             * The id of the price.
-             */
-            price_id?: string;
-            /**
-             * The ids of the coupons applicable to the price item
-             */
-            coupon_ids?: string[];
-            /**
-             * The taxes applied to the price item.
-             */
-            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
-            /**
-             * The taxes applied to the price item.
-             */
-            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
             /**
-             * The flag for prices that contain price components.
+             * Specifies whether the price is considered `inclusive` of taxes or not.
              */
-            is_composite_price?: boolean;
+            is_tax_inclusive?: boolean;
             /**
              * The snapshot of the product.
              * example:
@@ -1228,6 +1576,31 @@ declare namespace Components {
                  */
                 _updated_at?: string;
             };
+            external_fees_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "amount_total": 1000,
+             *     "amount_total_decimal": "10.00"
+             *   }
+             * ]
+             */
+            ExternalFeeMappings;
+            external_fees_metadata?: ExternalFeeMetadata;
+            /**
+             * The ids of the coupons applicable to the price item
+             */
+            coupon_ids?: string[];
+            /**
+             * The taxes applied to the price item.
+             */
+            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
+            /**
+             * The taxes applied to the price item.
+             */
+            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
             /**
              * The coupons applicable to the price item
              */
@@ -1262,10 +1635,6 @@ declare namespace Components {
              * }
              */
             Coupon)[];
-            /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
-             */
-            is_tax_inclusive?: boolean;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -2418,147 +2787,314 @@ declare namespace Components {
             concession_type?: /* The concession type for gas */ GasConcessionType;
             meter_type?: /* The meter type for power */ PowerMeterType;
             /**
-             * Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
-             *
+             * Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
+             *
+             */
+            markup_tiers?: PriceTier[];
+            markup_amount: number;
+            markup_amount_decimal: string;
+            markup_amount_net?: number;
+            markup_amount_net_decimal?: string;
+            unit_amount_gross: number;
+            unit_amount_gross_decimal?: string;
+            unit_amount_net: number;
+            unit_amount_net_decimal?: string;
+        }
+        /**
+         * example:
+         * {
+         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+         *   "frequency_unit": "weekly",
+         *   "value": 1000.245,
+         *   "name": "avg consumption",
+         *   "metadata": {
+         *     "journey_title": "energy journey",
+         *     "step_name": "avg consumption picker"
+         *   }
+         * }
+         */
+        export interface PriceInputMapping {
+            price_id?: string;
+            frequency_unit?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+            name?: string;
+            value?: number;
+            metadata?: {
+                [name: string]: string;
+            };
+        }
+        /**
+         * example:
+         * [
+         *   {
+         *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+         *     "frequency_unit": "weekly",
+         *     "value": 1000.245,
+         *     "name": "avg consumption",
+         *     "metadata": {
+         *       "journey_title": "energy journey",
+         *       "step_name": "avg consumption picker"
+         *     }
+         *   }
+         * ]
+         */
+        export type PriceInputMappings = /**
+         * example:
+         * {
+         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+         *   "frequency_unit": "weekly",
+         *   "value": 1000.245,
+         *   "name": "avg consumption",
+         *   "metadata": {
+         *     "journey_title": "energy journey",
+         *     "step_name": "avg consumption picker"
+         *   }
+         * }
+         */
+        PriceInputMapping[];
+        /**
+         * Represents a price item
+         * example:
+         * {
+         *   "$ref": "#/components/examples/price-item/value"
+         * }
+         */
+        export interface PriceItem {
+            /**
+             * Total of all items before (discounts or) taxes are applied.
+             */
+            amount_subtotal?: number;
+            /**
+             * Total of all items before (discounts or) taxes are applied, as a string with all the decimal places.
+             */
+            amount_subtotal_decimal?: string;
+            /**
+             * Total of all items after (discounts and) taxes are applied.
+             */
+            amount_total?: number;
+            /**
+             * Total of all items after (discounts and) taxes are applied, as a string with all the decimal places.
+             */
+            amount_total_decimal?: string;
+            /**
+             * The discount amount.
+             */
+            discount_amount?: number;
+            /**
+             * The discount amount as a string with all the decimal places.
+             */
+            discount_amount_decimal?: string;
+            /**
+             * The discount percentage, if the applied coupon had a percentage type.
+             */
+            discount_percentage?: number;
+            /**
+             * Total amount before discount is applied.
+             */
+            before_discount_amount_total?: number;
+            /**
+             * Total amount before discount is applied as a string with all the decimal places.
+             */
+            before_discount_amount_total_decimal?: string;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            /**
+             * The quantity of products being purchased.
+             */
+            quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
+            price_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "value": 1000.245,
+             *     "name": "avg consumption",
+             *     "metadata": {
+             *       "journey_title": "energy journey",
+             *       "step_name": "avg consumption picker"
+             *     }
+             *   }
+             * ]
+             */
+            PriceInputMappings;
+            /**
+             * Specifies whether the price is considered `inclusive` of taxes or not.
+             */
+            is_tax_inclusive?: boolean;
+            /**
+             * The snapshot of the product.
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            _product?: {
+                [name: string]: any;
+                /**
+                 * The description for the product
+                 */
+                description?: string;
+                /**
+                 * The product code
+                 */
+                code?: string;
+                /**
+                 * The type of Product:
+                 *
+                 * | type | description |
+                 * |----| ----|
+                 * | `product` | Represents a physical good |
+                 * | `service` | Represents a service or virtual product |
+                 *
+                 */
+                type?: "product" | "service";
+                /**
+                 * The product main name
+                 */
+                name?: string;
+                feature?: {
+                    /**
+                     * An arbitrary set of tags attached to a feature
+                     */
+                    _tags?: string[];
+                    feature?: string;
+                }[];
+                /**
+                 * Stores references to products that can be cross sold with the current product.
+                 */
+                cross_sellable_products?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of file images of the product
+                 */
+                product_images?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to a set of files downloadable from the product.
+                 * e.g: tech specifications, quality control sheets, privacy policy agreements
+                 *
+                 */
+                product_downloads?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * A set of [prices](/api/pricing#tag/simple_price_schema) or [composite prices](/api/pricing#tag/dynamic_price_schema) for the current product.
+                 */
+                price_options?: {
+                    $relation?: EntityRelation[];
+                };
+                /**
+                 * Stores references to the availability files that define where this product is available.
+                 * These files are used when interacting with products via epilot Journeys, thought the AvailabilityCheck block.
+                 *
+                 */
+                _availability_files?: File[];
+                /**
+                 * The product id
+                 */
+                _id?: string;
+                /**
+                 * The autogenerated product title
+                 */
+                _title?: string;
+                /**
+                 * The organization id the product belongs to
+                 */
+                _org_id?: string;
+                /**
+                 * The product creation date
+                 */
+                _created_at?: string;
+                /**
+                 * The product last update date
+                 */
+                _updated_at?: string;
+            };
+            /**
+             * price item id
              */
-            markup_tiers?: PriceTier[];
-            markup_amount: number;
-            markup_amount_decimal: string;
-            markup_amount_net?: number;
-            markup_amount_net_decimal?: string;
-            unit_amount_gross: number;
-            unit_amount_gross_decimal?: string;
-            unit_amount_net: number;
-            unit_amount_net_decimal?: string;
-        }
-        /**
-         * example:
-         * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "value": 1000.245,
-         *   "name": "avg consumption",
-         *   "metadata": {
-         *     "journey_title": "energy journey",
-         *     "step_name": "avg consumption picker"
-         *   }
-         * }
-         */
-        export interface PriceInputMapping {
-            price_id?: string;
-            frequency_unit?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
-            name?: string;
-            value?: number;
-            metadata?: {
-                [name: string]: string;
-            };
-        }
-        /**
-         * example:
-         * [
-         *   {
-         *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *     "frequency_unit": "weekly",
-         *     "value": 1000.245,
-         *     "name": "avg consumption",
-         *     "metadata": {
-         *       "journey_title": "energy journey",
-         *       "step_name": "avg consumption picker"
-         *     }
-         *   }
-         * ]
-         */
-        export type PriceInputMappings = /**
-         * example:
-         * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "value": 1000.245,
-         *   "name": "avg consumption",
-         *   "metadata": {
-         *     "journey_title": "energy journey",
-         *     "step_name": "avg consumption picker"
-         *   }
-         * }
-         */
-        PriceInputMapping[];
-        /**
-         * Represents a price item
-         * example:
-         * {
-         *   "$ref": "#/components/examples/price-item/value"
-         * }
-         */
-        export interface PriceItem {
+            _id?: string;
             /**
-             * Total of all items before (discounts or) taxes are applied.
+             * The unit amount value
              */
-            amount_subtotal?: number;
+            unit_amount?: number;
             /**
-             * Total of all items before (discounts or) taxes are applied, as a string with all the decimal places.
+             * The unit amount before any discount is applied
              */
-            amount_subtotal_decimal?: string;
+            before_discount_unit_amount?: number;
             /**
-             * Total of all items after (discounts and) taxes are applied.
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
              */
-            amount_total?: number;
+            unit_amount_decimal?: string;
             /**
-             * Total of all items after (discounts and) taxes are applied, as a string with all the decimal places.
+             * The discount amount applied for each unit
              */
-            amount_total_decimal?: string;
+            unit_discount_amount?: number;
             /**
-             * The discount amount.
+             * The discount amount applied for each unit represented as a decimal string
              */
-            discount_amount?: number;
+            unit_discount_amount_decimal?: string;
             /**
-             * The discount amount as a string with all the decimal places.
+             * The unit gross amount value.
              */
-            discount_amount_decimal?: string;
+            unit_amount_gross?: number;
             /**
-             * The discount percentage, if the applied coupon had a percentage type.
+             * The unit gross amount value.
              */
-            discount_percentage?: number;
+            unit_amount_gross_decimal?: string;
             /**
-             * Total amount before discount is applied.
+             * Net unit amount without taxes or discounts.
              */
-            before_discount_amount_total?: number;
+            unit_amount_net?: number;
             /**
-             * Total amount before discount is applied as a string with all the decimal places.
+             * Net unit amount without taxes or discounts.
              */
-            before_discount_amount_total_decimal?: string;
+            unit_amount_net_decimal?: string;
             /**
-             * price item id
+             * The net discount amount applied for each unit
              */
-            _id?: string;
-            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            unit_discount_amount_net?: number;
             /**
-             * The unit amount value
+             * The net discount amount applied for each unit represented as a decimal string
              */
-            unit_amount?: number;
+            unit_discount_amount_net_decimal?: string;
             /**
-             * The unit gross amount value.
+             * The discount amount applied to the tax
              */
-            unit_amount_gross?: number;
+            tax_discount_amount?: number;
             /**
-             * The unit gross amount value.
+             * The discount amount applied to the tax represented as a decimal string
              */
-            unit_amount_gross_decimal?: string;
+            tax_discount_amount_decimal?: string;
             /**
              * Total tax amount for this line item.
              */
             amount_tax?: number;
             /**
-             * Net unit amount without taxes or discounts.
-             */
-            unit_amount_net?: number;
-            /**
-             * Net unit amount without taxes or discounts.
+             * The tax amount before any discount is applied
              */
-            unit_amount_net_decimal?: string;
+            before_discount_tax_amount?: number;
             /**
-             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             * The tax amount before any discount is applied represented as a decimal string
              */
-            unit_amount_decimal?: string;
+            before_discount_tax_amount_decimal?: string;
             currency?: /**
              * 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
@@ -2567,26 +3103,6 @@ declare namespace Components {
              * EUR
              */
             Currency;
-            /**
-             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
-             */
-            description?: string;
-            /**
-             * The quantity of products being purchased.
-             */
-            quantity?: number;
-            /**
-             * The id of the product.
-             */
-            product_id?: string;
-            /**
-             * The id of the price.
-             */
-            price_id?: string;
-            /**
-             * The flag for prices that contain price components.
-             */
-            is_composite_price?: boolean;
             /**
              * The price snapshot data.
              */
@@ -2605,14 +3121,6 @@ declare namespace Components {
              * }
              */
             CompositePrice;
-            _product?: /**
-             * The product entity
-             * example:
-             * {
-             *   "$ref": "#/components/examples/product"
-             * }
-             */
-            Product;
             /**
              * The taxes applied to the price item.
              */
@@ -2621,30 +3129,10 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-            price_mappings?: /**
-             * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "value": 1000.245,
-             *     "name": "avg consumption",
-             *     "metadata": {
-             *       "journey_title": "energy journey",
-             *       "step_name": "avg consumption picker"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
             /**
              * When set to true on a `_price` displayed as OnRequest (`show_as_on_request: 'on_request'`) this flag means the price has been approved and can now be displayed to the customer. This flag is only valid for prices shown as 'on_request'.
              */
             on_request_approved?: boolean;
-            /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
-             */
-            is_tax_inclusive?: boolean;
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -2675,6 +3163,22 @@ declare namespace Components {
              * The quantity of products being purchased.
              */
             quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -2691,47 +3195,10 @@ declare namespace Components {
              * ]
              */
             PriceInputMappings;
-            external_fees_mappings?: /**
-             * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
-             */
-            ExternalFeeMappings;
-            external_fees_metadata?: ExternalFeeMetadata;
-            /**
-             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
-             */
-            description?: string;
-            /**
-             * The id of the product.
-             */
-            product_id?: string;
-            /**
-             * The id of the price.
-             */
-            price_id?: string;
-            /**
-             * The ids of the coupons applicable to the price item
-             */
-            coupon_ids?: string[];
-            /**
-             * The taxes applied to the price item.
-             */
-            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
-            /**
-             * The taxes applied to the price item.
-             */
-            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
             /**
-             * The flag for prices that contain price components.
+             * Specifies whether the price is considered `inclusive` of taxes or not.
              */
-            is_composite_price?: boolean;
+            is_tax_inclusive?: boolean;
             /**
              * The snapshot of the product.
              * example:
@@ -2823,6 +3290,31 @@ declare namespace Components {
                  */
                 _updated_at?: string;
             };
+            external_fees_mappings?: /**
+             * example:
+             * [
+             *   {
+             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+             *     "frequency_unit": "weekly",
+             *     "amount_total": 1000,
+             *     "amount_total_decimal": "10.00"
+             *   }
+             * ]
+             */
+            ExternalFeeMappings;
+            external_fees_metadata?: ExternalFeeMetadata;
+            /**
+             * The ids of the coupons applicable to the price item
+             */
+            coupon_ids?: string[];
+            /**
+             * The taxes applied to the price item.
+             */
+            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
+            /**
+             * The taxes applied to the price item.
+             */
+            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
             /**
              * The coupons applicable to the price item
              */
@@ -2857,10 +3349,6 @@ declare namespace Components {
              * }
              */
             Coupon)[];
-            /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
-             */
-            is_tax_inclusive?: boolean;
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -4427,6 +4915,7 @@ export type AvailabilityFilters = Components.Schemas.AvailabilityFilters;
 export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
 export type AvailabilityResult = Components.Schemas.AvailabilityResult;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
+export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
 export type BasePriceItemDto = Components.Schemas.BasePriceItemDto;
 export type BasicAuthCredentials = Components.Schemas.BasicAuthCredentials;
 export type BillingPeriod = Components.Schemas.BillingPeriod;