@epilot/pricing-client 3.47.9-alpha.7 → 3.47.10

package/dist/openapi.d.ts

@@ -81,14 +81,6 @@ declare namespace Components {
              * 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 cashback amount.
              */
@@ -97,10 +89,7 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * Total amount after cashback is applied.
              */
@@ -109,6 +98,14 @@ declare namespace Components {
              * Total amount after cashback is applied as a string with all the decimal places.
              */
             after_cashback_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.
              */
@@ -254,36 +251,111 @@ declare namespace Components {
             _meta?: /* Signature meta data payload */ SignatureMeta;
         }
         /**
-         * The coupon configuration
+         * The common properties for a composite price entity, without the price components
          * example:
          * {
-         *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "_schema": "coupon",
-         *   "_org": "org_12345",
-         *   "_created_at": "2024-01-15T10:00:00.000Z",
-         *   "_updated_at": "2024-01-20T12:00:00.000Z",
-         *   "_title": "Sample Coupon",
-         *   "name": "Sample Coupon",
-         *   "type": "fixed",
-         *   "fixed_value": 555,
-         *   "fixed_value_currency": "USD",
-         *   "fixed_value_decimal": "5.55",
-         *   "active": true,
-         *   "prices": {
-         *     "$relation": [
-         *       {
-         *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-         *         "_tags": [
-         *           "discount",
-         *           "special"
-         *         ],
-         *         "_schema": "price"
-         *       }
-         *     ]
-         *   }
+         *   "$ref": "#/components/examples/composite-price"
          * }
          */
-        export interface BaseCoupon {
+        export interface BaseCompositePrice {
+            [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * Whether the price can be used for new purchases.
+             */
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price[] | {
+                $relation?: PriceComponentRelation[];
+            };
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * 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 flag for prices that contain price components.
+             */
+            is_composite_price: true;
+            /**
+             * The price creation date
+             */
+            _created_at?: string;
+            /**
+             * The price id
+             */
+            _id?: string;
+            /**
+             * The price autogenerated title
+             */
+            _title?: string;
+            /**
+             * The price last update date
+             */
+            _updated_at?: string;
+            /**
+             * The organization id the price belongs to
+             */
+            _org_id?: string;
+            /**
+             * An arbitrary set of tags attached to the composite price
+             */
+            _tags?: string[];
+        }
+        /**
+         * The shared properties for the coupon entity and coupon item entity
+         */
+        export interface BaseCouponCommon {
             [name: string]: any;
             _id: EntityId /* uuid */;
             /**
@@ -309,8 +381,8 @@ declare namespace Components {
             _updated_at: string; // date-time
             name: string | null;
             description?: string | null;
-            type?: "fixed" | "percentage";
-            category?: "discount" | "cashback";
+            type: "fixed" | "percentage";
+            category: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
@@ -334,28 +406,12 @@ declare namespace Components {
              * EUR
              */
             Currency;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             active?: boolean;
             /**
              * Whether the coupon requires a promo code to be applied
              */
             requires_promo_code?: boolean;
-            /**
-             * The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.
-             */
-            prices?: /* The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise. */ {
-                $relation?: EntityRelation[];
-            } | /**
-             * The price entity schema for simple pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price"
-             * }
-             */
-            Price[];
         }
         export interface BaseMarketPriceRecord {
             /**
@@ -403,14 +459,6 @@ declare namespace Components {
              * 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 cashback amount.
              */
@@ -419,10 +467,7 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * Total amount after cashback is applied.
              */
@@ -431,6 +476,14 @@ declare namespace Components {
              * Total amount after cashback is applied as a string with all the decimal places.
              */
             after_cashback_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.
              */
@@ -702,14 +755,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            Price | /* The composite price entity */ CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -721,7 +767,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * 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'.
              */
@@ -1031,14 +1077,9 @@ declare namespace Components {
             };
             external_fees_mappings?: /**
              * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * {
+             *   "$ref": "#/components/examples/external-fee-mappings/value"
+             * }
              */
             ExternalFeeMappings;
             external_fees_metadata?: ExternalFeeMetadata;
@@ -1059,7 +1100,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
         }
         export interface BasicAuthCredentials {
             /**
@@ -1117,14 +1158,6 @@ declare namespace Components {
              * 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 cashback amount.
              */
@@ -1133,10 +1166,7 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * Total amount after cashback is applied.
              */
@@ -1145,6 +1175,14 @@ declare namespace Components {
              * Total amount after cashback is applied as a string with all the decimal places.
              */
             after_cashback_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.
              */
@@ -1238,15 +1276,35 @@ declare namespace Components {
          * An amount associated with a specific cashback period.
          */
         export interface CashbackAmount {
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period: "0" | "12";
+            cashback_period: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * The sum of all cashbacks for a specific cashback period
              */
             amount_total: number;
         }
+        export interface CashbackAmounts {
+            /**
+             * The cashback amount.
+             */
+            cashback_amount?: number;
+            /**
+             * The cashback amount as a string with all the decimal places.
+             */
+            cashback_amount_decimal?: string;
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
+        }
+        /**
+         * The cashback period, for now it's limited to either 0 months or 12 months
+         */
+        export type CashbackPeriod = "0" | "12";
         /**
          * A catalog search payload
          * example:
@@ -1317,33 +1375,10 @@ declare namespace Components {
              * }
              */
             Price | /**
-             * The coupon configuration
+             * The coupon entity
              * example:
              * {
-             *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "_schema": "coupon",
-             *   "_org": "org_12345",
-             *   "_created_at": "2024-01-15T10:00:00.000Z",
-             *   "_updated_at": "2024-01-20T12:00:00.000Z",
-             *   "_title": "Sample Coupon",
-             *   "name": "Sample Coupon",
-             *   "type": "fixed",
-             *   "fixed_value": 555,
-             *   "fixed_value_currency": "USD",
-             *   "fixed_value_decimal": "5.55",
-             *   "active": true,
-             *   "prices": {
-             *     "$relation": [
-             *       {
-             *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-             *         "_tags": [
-             *           "discount",
-             *           "special"
-             *         ],
-             *         "_schema": "price"
-             *       }
-             *     ]
-             *   }
+             *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
              * }
              */
             Coupon)[];
@@ -1374,159 +1409,72 @@ declare namespace Components {
          */
         export type CheckoutMode = "create_order" | "create_invoice" | "create_quote";
         /**
-         * The price entity schema for dynamic pricing
+         * The composite price entity
+         */
+        export type CompositePrice = /* The composite price entity */ /**
+         * The composite price entity
          * example:
          * {
          *   "$ref": "#/components/examples/composite-price"
          * }
          */
-        export interface CompositePrice {
-            [name: string]: any;
+        NonHydratedCompositePrice | /**
+         * The composite price entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        HydratedCompositePrice;
+        /**
+         * Represents a composite price input to the pricing library.
+         * example:
+         * {
+         *   "$ref": "#/components/examples/price-item/value"
+         * }
+         */
+        export interface CompositePriceItem {
             /**
-             * The billing period duration
+             * Total of all items before (discounts or) taxes are applied.
              */
-            billing_duration_amount?: number;
+            amount_subtotal?: number;
             /**
-             * The billing period duration unit
+             * Total of all items before (discounts or) taxes are applied, as a string with all the decimal places.
              */
-            billing_duration_unit?: "weeks" | "months" | "years";
+            amount_subtotal_decimal?: string;
             /**
-             * The notice period duration
+             * Total of all items after (discounts and) taxes are applied.
              */
-            notice_time_amount?: number;
+            amount_total?: number;
             /**
-             * The notice period duration unit
+             * Total of all items after (discounts and) taxes are applied, as a string with all the decimal places.
              */
-            notice_time_unit?: "weeks" | "months" | "years";
+            amount_total_decimal?: string;
             /**
-             * The termination period duration
+             * The cashback amount.
              */
-            termination_time_amount?: number;
+            cashback_amount?: number;
             /**
-             * The termination period duration unit
+             * The cashback amount as a string with all the decimal places.
              */
-            termination_time_unit?: "weeks" | "months" | "years";
+            cashback_amount_decimal?: string;
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
-             * The renewal period duration
+             * Total amount after cashback is applied.
              */
-            renewal_duration_amount?: number;
+            after_cashback_amount_total?: number;
             /**
-             * The renewal period duration unit
+             * Total amount after cashback is applied as a string with all the decimal places.
              */
-            renewal_duration_unit?: "weeks" | "months" | "years";
+            after_cashback_amount_total_decimal?: string;
             /**
-             * Whether the price can be used for new purchases.
+             * The discount amount.
              */
-            active?: boolean;
+            discount_amount?: number;
             /**
-             * A brief description of the price.
-             */
-            description?: string;
-            /**
-             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
-             */
-            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ /**
-             * The price entity schema for simple pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price"
-             * }
-             */
-            Price[] | {
-                $relation?: PriceComponentRelation[];
-            };
-            /**
-             * Three-letter ISO currency code, in lowercase.
-             */
-            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
-             * 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 flag for prices that contain price components.
-             */
-            is_composite_price?: boolean;
-            /**
-             * The price creation date
-             */
-            _created_at?: string;
-            /**
-             * The price id
-             */
-            _id?: string;
-            /**
-             * The price autogenerated title
-             */
-            _title?: string;
-            /**
-             * The price last update date
-             */
-            _updated_at?: string;
-            /**
-             * The organization id the price belongs to
-             */
-            _org_id?: string;
-            /**
-             * An arbitrary set of tags attached to the composite price
-             */
-            _tags?: string[];
-        }
-        /**
-         * Represents a composite price input to the pricing library.
-         * example:
-         * {
-         *   "$ref": "#/components/examples/price-item/value"
-         * }
-         */
-        export interface CompositePriceItem {
-            /**
-             * 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.
+             * The discount amount as a string with all the decimal places.
              */
             discount_amount_decimal?: string;
-            /**
-             * The cashback amount.
-             */
-            cashback_amount?: number;
-            /**
-             * The cashback amount as a string with all the decimal places.
-             */
-            cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
-            /**
-             * Total amount after cashback is applied.
-             */
-            after_cashback_amount_total?: number;
-            /**
-             * Total amount after cashback is applied as a string with all the decimal places.
-             */
-            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -1798,14 +1746,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            Price | /* The composite price entity */ CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -1815,13 +1756,90 @@ declare namespace Components {
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
             /**
-             * The coupons applicable to the price item
+             * The coupons applicable to the composite price item + related (cashback) amounts
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: ({
+                [name: string]: any;
+                _id: EntityId /* uuid */;
+                /**
+                 * The auto-generated title for the title
+                 */
+                _title: string;
+                /**
+                 * Organization Id the entity belongs to
+                 */
+                _org: string;
+                /**
+                 * The schema of the entity, for coupons it is always `coupon`
+                 */
+                _schema: "coupon";
+                _tags?: string[];
+                /**
+                 * The creation date for the opportunity
+                 */
+                _created_at: string; // date-time
+                /**
+                 * The date the coupon was last updated
+                 */
+                _updated_at: string; // date-time
+                name: string | null;
+                description?: string | null;
+                type: "fixed" | "percentage";
+                category: "discount" | "cashback";
+                /**
+                 * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
+                 */
+                percentage_value?: string | null;
+                /**
+                 * Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.
+                 */
+                fixed_value?: number;
+                /**
+                 * Use if type is set to fixed. The unit amount in cents to be discounted, represented as a decimal string with at most 12 decimal places.
+                 */
+                fixed_value_decimal?: string;
+                /**
+                 * Use if type is set to fixed. Three-letter ISO currency code, in lowercase.
+                 */
+                fixed_value_currency?: /* Use if type is set to fixed. Three-letter ISO currency code, in lowercase. */ /**
+                 * 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;
+                cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
+                active?: boolean;
+                /**
+                 * Whether the coupon requires a promo code to be applied
+                 */
+                requires_promo_code?: boolean;
+                /**
+                 * The cashback amount.
+                 */
+                cashback_amount?: number;
+                /**
+                 * The cashback amount as a string with all the decimal places.
+                 */
+                cashback_amount_decimal?: string;
+                /**
+                 * Total amount after cashback is applied.
+                 */
+                after_cashback_amount_total?: number;
+                /**
+                 * Total amount after cashback is applied as a string with all the decimal places.
+                 */
+                after_cashback_amount_total_decimal?: string;
+            } & /* The shared properties for the coupon entity and coupon item entity */ (/* The shared properties for the coupon entity and coupon item entity */ CouponItem))[];
             /**
              * 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;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price: true;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -1986,14 +2004,9 @@ declare namespace Components {
             };
             external_fees_mappings?: /**
              * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * {
+             *   "$ref": "#/components/examples/external-fee-mappings/value"
+             * }
              */
             ExternalFeeMappings;
             external_fees_metadata?: ExternalFeeMetadata;
@@ -2014,11 +2027,11 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * The flag for prices that contain price components.
              */
-            is_composite_price?: true;
+            is_composite_price: true;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -2033,14 +2046,7 @@ declare namespace Components {
             price_component_coupon_ids?: {
                 [name: string]: string[];
             };
-            _price?: /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            _price?: /* The composite price entity */ CompositePrice;
         }
         /**
          * The compute price payload
@@ -2269,33 +2275,10 @@ declare namespace Components {
         }
         export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
         /**
-         * The coupon configuration
+         * The coupon entity
          * example:
          * {
-         *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "_schema": "coupon",
-         *   "_org": "org_12345",
-         *   "_created_at": "2024-01-15T10:00:00.000Z",
-         *   "_updated_at": "2024-01-20T12:00:00.000Z",
-         *   "_title": "Sample Coupon",
-         *   "name": "Sample Coupon",
-         *   "type": "fixed",
-         *   "fixed_value": 555,
-         *   "fixed_value_currency": "USD",
-         *   "fixed_value_decimal": "5.55",
-         *   "active": true,
-         *   "prices": {
-         *     "$relation": [
-         *       {
-         *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-         *         "_tags": [
-         *           "discount",
-         *           "special"
-         *         ],
-         *         "_schema": "price"
-         *       }
-         *     ]
-         *   }
+         *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
          * }
          */
         export interface Coupon {
@@ -2324,8 +2307,8 @@ declare namespace Components {
             _updated_at: string; // date-time
             name: string | null;
             description?: string | null;
-            type?: "fixed" | "percentage";
-            category?: "discount" | "cashback";
+            type: "fixed" | "percentage";
+            category: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
@@ -2349,10 +2332,7 @@ declare namespace Components {
              * EUR
              */
             Currency;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             active?: boolean;
             /**
              * Whether the coupon requires a promo code to be applied
@@ -2374,10 +2354,7 @@ declare namespace Components {
             promo_codes?: /**
              * example:
              * {
-             *   "id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "code": "123456",
-             *   "has_usage_limit": true,
-             *   "usage_limit": 10
+             *   "$ref": "#/components/examples/promo-code/value"
              * }
              */
             PromoCode[];
@@ -2388,16 +2365,20 @@ declare namespace Components {
                 [name: string]: number;
             };
         }
+        /**
+         * The shared properties for the coupon entity and coupon item entity
+         */
         export interface CouponItem {
-            _id?: EntityId /* uuid */;
+            [name: string]: any;
+            _id: EntityId /* uuid */;
             /**
              * The auto-generated title for the title
              */
-            _title?: string;
+            _title: string;
             /**
              * Organization Id the entity belongs to
              */
-            _org?: string;
+            _org: string;
             /**
              * The schema of the entity, for coupons it is always `coupon`
              */
@@ -2406,12 +2387,12 @@ declare namespace Components {
             /**
              * The creation date for the opportunity
              */
-            _created_at?: string; // date-time
+            _created_at: string; // date-time
             /**
              * The date the coupon was last updated
              */
-            _updated_at?: string; // date-time
-            name?: string | null;
+            _updated_at: string; // date-time
+            name: string | null;
             description?: string | null;
             type: "fixed" | "percentage";
             category: "discount" | "cashback";
@@ -2438,10 +2419,7 @@ declare namespace Components {
              * EUR
              */
             Currency;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             active?: boolean;
             /**
              * Whether the coupon requires a promo code to be applied
@@ -2449,33 +2427,10 @@ declare namespace Components {
             requires_promo_code?: boolean;
         }
         /**
-         * The coupon configuration
+         * The base for the coupon entity without promo codes
          * example:
          * {
-         *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "_schema": "coupon",
-         *   "_org": "org_12345",
-         *   "_created_at": "2024-01-15T10:00:00.000Z",
-         *   "_updated_at": "2024-01-20T12:00:00.000Z",
-         *   "_title": "Sample Coupon",
-         *   "name": "Sample Coupon",
-         *   "type": "fixed",
-         *   "fixed_value": 555,
-         *   "fixed_value_currency": "USD",
-         *   "fixed_value_decimal": "5.55",
-         *   "active": true,
-         *   "prices": {
-         *     "$relation": [
-         *       {
-         *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-         *         "_tags": [
-         *           "discount",
-         *           "special"
-         *         ],
-         *         "_schema": "price"
-         *       }
-         *     ]
-         *   }
+         *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
          * }
          */
         export interface CouponWithoutPromoCodes {
@@ -2504,8 +2459,8 @@ declare namespace Components {
             _updated_at: string; // date-time
             name: string | null;
             description?: string | null;
-            type?: "fixed" | "percentage";
-            category?: "discount" | "cashback";
+            type: "fixed" | "percentage";
+            category: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
@@ -2529,10 +2484,7 @@ declare namespace Components {
              * EUR
              */
             Currency;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             active?: boolean;
             /**
              * Whether the coupon requires a promo code to be applied
@@ -2571,6 +2523,28 @@ declare namespace Components {
             email?: string;
             phone?: string;
         }
+        export interface DiscountAmounts {
+            /**
+             * 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;
+        }
         /**
          * The interval of the tariff if a spot market price is used as base.
          */
@@ -2583,15 +2557,7 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-         *   "_org": "123",
-         *   "_schema": "contact",
-         *   "_tags": [
-         *     "example",
-         *     "mock"
-         *   ],
-         *   "_created_at": "2021-02-09T12:41:43.662Z",
-         *   "_updated_at": "2021-02-09T12:41:43.662Z"
+         *   "$ref": "#/components/examples/entity-item/value"
          * }
          */
         export interface EntityItem {
@@ -2638,10 +2604,7 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "amount_total": 1000,
-         *   "amount_total_decimal": "10.00"
+         *   "$ref": "#/components/examples/external-fee-mapping/value"
          * }
          */
         export interface ExternalFeeMapping {
@@ -2652,22 +2615,14 @@ declare namespace Components {
         }
         /**
          * example:
-         * [
-         *   {
-         *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *     "frequency_unit": "weekly",
-         *     "amount_total": 1000,
-         *     "amount_total_decimal": "10.00"
-         *   }
-         * ]
+         * {
+         *   "$ref": "#/components/examples/external-fee-mappings/value"
+         * }
          */
         export type ExternalFeeMappings = /**
          * example:
          * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "amount_total": 1000,
-         *   "amount_total_decimal": "10.00"
+         *   "$ref": "#/components/examples/external-fee-mapping/value"
          * }
          */
         ExternalFeeMapping[];
@@ -2807,6 +2762,113 @@ declare namespace Components {
             bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
             prices: /* A market price at a given point in time. */ HistoricMarketPriceRecord[];
         }
+        /**
+         * The composite price entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        export interface HydratedCompositePrice {
+            [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * Whether the price can be used for new purchases.
+             */
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price[] | /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price[];
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * 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 flag for prices that contain price components.
+             */
+            is_composite_price: true;
+            /**
+             * The price creation date
+             */
+            _created_at?: string;
+            /**
+             * The price id
+             */
+            _id?: string;
+            /**
+             * The price autogenerated title
+             */
+            _title?: string;
+            /**
+             * The price last update date
+             */
+            _updated_at?: string;
+            /**
+             * The organization id the price belongs to
+             */
+            _org_id?: string;
+            /**
+             * An arbitrary set of tags attached to the composite price
+             */
+            _tags?: string[];
+        }
         /**
          * The auth credentials for external integrations
          */
@@ -2819,86 +2881,183 @@ declare namespace Components {
              * example:
              * 8d0a2235-97ce-42d0-88a3-e374634ca44e
              */
-            journey_id: string;
+            journey_id: string;
+            /**
+             * The name of the journey.
+             * example:
+             * journey name
+             */
+            journey_name: string;
+            /**
+             * The tags of the journey.
+             */
+            journey_tags?: string[];
+            /**
+             * The URL parameters of the journey.
+             */
+            journey_url_params?: {
+                [name: string]: any;
+            };
+            /**
+             * The name of the step where the products selection is happening.
+             * example:
+             * step name
+             */
+            current_step_name: string;
+            /**
+             * The name of the block where the products selection is happening.
+             * example:
+             * block name
+             */
+            current_block_name: string;
+            /**
+             * The steps of the journey.
+             */
+            steps_data: {
+                /**
+                 * The name of the step.
+                 */
+                step_name: string;
+                /**
+                 * The index of the step.
+                 */
+                step_index: number;
+                /**
+                 * The data of the blocks.
+                 * example:
+                 * {
+                 *   "Adresse": {
+                 *     "countryCode": "DE",
+                 *     "city": "Koblenz",
+                 *     "zipCode": "56068",
+                 *     "streetName": "Am Alten Hospital",
+                 *     "houseNumber": "123"
+                 *   }
+                 * }
+                 */
+                blocks: {
+                    [name: string]: any;
+                };
+            }[];
+        }
+        /**
+         * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
+         * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
+         * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unitary 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.
+         *
+         */
+        export type MarkupPricingModel = "per_unit" | "tiered_volume" | "tiered_flatfee";
+        /**
+         * A set of key-value pairs used to store meta data information about an entity.
+         */
+        export type MetaData = ({
+            /**
+             * Item key
+             */
+            key?: string;
+            /**
+             * Item value
+             */
+            value?: string;
+        })[];
+        /**
+         * The composite price entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        export interface NonHydratedCompositePrice {
+            [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * Whether the price can be used for new purchases.
+             */
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ {
+                $relation?: PriceComponentRelation[];
+            } | {
+                $relation?: PriceComponentRelation[];
+            };
             /**
-             * The name of the journey.
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * 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:
-             * journey name
+             * EUR
              */
-            journey_name: string;
+            Currency;
             /**
-             * The tags of the journey.
+             * The flag for prices that contain price components.
              */
-            journey_tags?: string[];
+            is_composite_price: true;
             /**
-             * The URL parameters of the journey.
+             * The price creation date
              */
-            journey_url_params?: {
-                [name: string]: any;
-            };
+            _created_at?: string;
             /**
-             * The name of the step where the products selection is happening.
-             * example:
-             * step name
+             * The price id
              */
-            current_step_name: string;
+            _id?: string;
             /**
-             * The name of the block where the products selection is happening.
-             * example:
-             * block name
+             * The price autogenerated title
              */
-            current_block_name: string;
+            _title?: string;
             /**
-             * The steps of the journey.
+             * The price last update date
              */
-            steps_data: {
-                /**
-                 * The name of the step.
-                 */
-                step_name: string;
-                /**
-                 * The index of the step.
-                 */
-                step_index: number;
-                /**
-                 * The data of the blocks.
-                 * example:
-                 * {
-                 *   "Adresse": {
-                 *     "countryCode": "DE",
-                 *     "city": "Koblenz",
-                 *     "zipCode": "56068",
-                 *     "streetName": "Am Alten Hospital",
-                 *     "houseNumber": "123"
-                 *   }
-                 * }
-                 */
-                blocks: {
-                    [name: string]: any;
-                };
-            }[];
-        }
-        /**
-         * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
-         * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
-         * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unitary 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.
-         *
-         */
-        export type MarkupPricingModel = "per_unit" | "tiered_volume" | "tiered_flatfee";
-        /**
-         * A set of key-value pairs used to store meta data information about an entity.
-         */
-        export type MetaData = ({
+            _updated_at?: string;
             /**
-             * Item key
+             * The organization id the price belongs to
              */
-            key?: string;
+            _org_id?: string;
             /**
-             * Item value
+             * An arbitrary set of tags attached to the composite price
              */
-            value?: string;
-        })[];
+            _tags?: string[];
+        }
         export interface OAuthCredentials {
             /**
              * The OAuth client ID
@@ -2957,6 +3116,11 @@ declare namespace Components {
              */
             base_url?: string;
         }
+        export interface Offer {
+            product_id?: string;
+            price_id?: string;
+            target_id?: string;
+        }
         /**
          * The opportunity entity
          * example:
@@ -3438,7 +3602,7 @@ declare namespace Components {
             /**
              * The flag for prices that contain price components.
              */
-            is_composite_price?: boolean;
+            is_composite_price?: false;
             /**
              * 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
@@ -3483,20 +3647,7 @@ declare namespace Components {
              * the tax configuration
              * example:
              * {
-             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-             *   "type": "VAT",
-             *   "description": "Tax description",
-             *   "active": "true",
-             *   "region": "DE",
-             *   "region_label": "Germany",
-             *   "_org": "123",
-             *   "_schema": "tax",
-             *   "_tags": [
-             *     "example",
-             *     "mock"
-             *   ],
-             *   "_created_at": "2021-02-09T12:41:43.662Z",
-             *   "_updated_at": "2021-02-09T12:41:43.662Z"
+             *   "$ref": "#/components/examples/tax/value"
              * }
              */
             Tax[];
@@ -3570,6 +3721,24 @@ declare namespace Components {
              */
             _tags?: string[];
         }
+        export interface PriceAmounts {
+            /**
+             * 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;
+        }
         export interface PriceComponentRelation {
             /**
              * The id of the price component
@@ -3698,14 +3867,7 @@ declare namespace Components {
         /**
          * 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"
-         *   }
+         *   "$ref": "#/components/examples/price-input-mapping/value"
          * }
          */
         export interface PriceInputMapping {
@@ -3735,14 +3897,7 @@ declare namespace Components {
         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"
-         *   }
+         *   "$ref": "#/components/examples/price-input-mapping/value"
          * }
          */
         PriceInputMapping[];
@@ -3770,14 +3925,6 @@ declare namespace Components {
              * 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 cashback amount.
              */
@@ -3786,10 +3933,7 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * Total amount after cashback is applied.
              */
@@ -3798,6 +3942,14 @@ declare namespace Components {
              * Total amount after cashback is applied as a string with all the decimal places.
              */
             after_cashback_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.
              */
@@ -4069,14 +4221,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            Price | /* The composite price entity */ CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -4088,7 +4233,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * 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'.
              */
@@ -4097,10 +4242,14 @@ declare namespace Components {
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
             type?: "one_time" | "recurring";
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: false;
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             pricing_model: /**
              * 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
@@ -4267,14 +4416,9 @@ declare namespace Components {
             };
             external_fees_mappings?: /**
              * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * {
+             *   "$ref": "#/components/examples/external-fee-mappings/value"
+             * }
              */
             ExternalFeeMappings;
             external_fees_metadata?: ExternalFeeMetadata;
@@ -4295,7 +4439,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -4303,7 +4447,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * The unit amount value
              */
@@ -4387,7 +4531,7 @@ declare namespace Components {
                 /**
                  * The flag for prices that contain price components.
                  */
-                is_composite_price?: boolean;
+                is_composite_price?: false;
                 /**
                  * 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
@@ -4432,20 +4576,7 @@ declare namespace Components {
                  * the tax configuration
                  * example:
                  * {
-                 *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-                 *   "type": "VAT",
-                 *   "description": "Tax description",
-                 *   "active": "true",
-                 *   "region": "DE",
-                 *   "region_label": "Germany",
-                 *   "_org": "123",
-                 *   "_schema": "tax",
-                 *   "_tags": [
-                 *     "example",
-                 *     "mock"
-                 *   ],
-                 *   "_created_at": "2021-02-09T12:41:43.662Z",
-                 *   "_updated_at": "2021-02-09T12:41:43.662Z"
+                 *   "$ref": "#/components/examples/tax/value"
                  * }
                  */
                 Tax[];
@@ -4520,7 +4651,7 @@ declare namespace Components {
                 _tags?: string[];
             };
         }
-        export type PriceItemUnion = /* Represents a price input to the pricing library. */ PriceItemDto | /* Represents a composite price input to the pricing library. */ CompositePriceItemDto;
+        export type PriceItemDtoUnion = /* Represents a price input to the pricing library. */ PriceItemDto | /* Represents a composite price input to the pricing library. */ CompositePriceItemDto;
         /**
          * Tracks a set of product prices, quantities, (discounts) and taxes.
          */
@@ -4542,7 +4673,7 @@ declare namespace Components {
         /**
          * A valid set of product prices, quantities, (discounts) and taxes from a client.
          */
-        export type PriceItemsDto = PriceItemUnion[];
+        export type PriceItemsDto = PriceItemDtoUnion[];
         export interface PriceTier {
             up_to?: number | null;
             flat_fee_amount?: number;
@@ -4779,10 +4910,80 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "code": "123456",
-         *   "has_usage_limit": true,
-         *   "usage_limit": 10
+         *   "$ref": "#/components/examples/entity-item/value"
+         * }
+         */
+        export interface ProductRecommendation {
+            _id: EntityId /* uuid */;
+            /**
+             * Title of entity
+             */
+            _title: string;
+            /**
+             * Organization Id the entity belongs to
+             */
+            _org: string;
+            _schema: string;
+            _tags?: string[];
+            _created_at: string; // date-time
+            _updated_at: string; // date-time
+            /**
+             * Price being used as source
+             */
+            source_price?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Product being used as source
+             */
+            source_product?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Type of product recommendation
+             */
+            type?: "change" | "cross-sell" | "up-sell";
+            offer?: Offer[];
+        }
+        /**
+         * Product recommendations request payload
+         */
+        export interface ProductRecommendationResponse {
+            /**
+             * The number os results returned.
+             */
+            hits?: number;
+            results?: /**
+             * example:
+             * {
+             *   "$ref": "#/components/examples/entity-item/value"
+             * }
+             */
+            ProductRecommendation[];
+        }
+        /**
+         * Product recommendations request payload
+         */
+        export interface ProductRecommendationSearch {
+            product_recommendation_ids?: string[];
+            /**
+             * The catalog item to be used as source for the recommendation
+             */
+            catalog_item?: {
+                /**
+                 * Product id
+                 */
+                product_id?: string;
+                /**
+                 * Product id
+                 */
+                price_id?: string;
+            };
+        }
+        /**
+         * example:
+         * {
+         *   "$ref": "#/components/examples/promo-code/value"
          * }
          */
         export interface PromoCode {
@@ -4808,36 +5009,13 @@ declare namespace Components {
          */
         export interface PromoCodeValidationResponse {
             matched_coupons?: /**
-             * The coupon configuration
+             * The base for the coupon entity without promo codes
              * example:
              * {
-             *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "_schema": "coupon",
-             *   "_org": "org_12345",
-             *   "_created_at": "2024-01-15T10:00:00.000Z",
-             *   "_updated_at": "2024-01-20T12:00:00.000Z",
-             *   "_title": "Sample Coupon",
-             *   "name": "Sample Coupon",
-             *   "type": "fixed",
-             *   "fixed_value": 555,
-             *   "fixed_value_currency": "USD",
-             *   "fixed_value_decimal": "5.55",
-             *   "active": true,
-             *   "prices": {
-             *     "$relation": [
-             *       {
-             *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-             *         "_tags": [
-             *           "discount",
-             *           "special"
-             *         ],
-             *         "_schema": "price"
-             *       }
-             *     ]
-             *   }
+             *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
              * }
              */
-            BaseCoupon[];
+            CouponWithoutPromoCodes[];
         }
         /**
          * The provider entity
@@ -4872,14 +5050,6 @@ declare namespace Components {
              * 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 cashback amount.
              */
@@ -4888,10 +5058,7 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * Total amount after cashback is applied.
              */
@@ -4900,6 +5067,14 @@ declare namespace Components {
              * Total amount after cashback is applied as a string with all the decimal places.
              */
             after_cashback_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.
              */
@@ -4919,7 +5094,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * The unit gross amount value.
              */
@@ -4965,14 +5140,6 @@ declare namespace Components {
              * 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 cashback amount.
              */
@@ -4981,10 +5148,7 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
-            /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
-             */
-            cashback_period?: "0" | "12";
+            cashback_period?: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod;
             /**
              * Total amount after cashback is applied.
              */
@@ -4993,6 +5157,14 @@ declare namespace Components {
              * Total amount after cashback is applied as a string with all the decimal places.
              */
             after_cashback_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.
              */
@@ -5012,7 +5184,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * The unit gross amount value.
              */
@@ -5037,7 +5209,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * Total amount of items with same recurrence.
              */
@@ -5066,33 +5238,10 @@ declare namespace Components {
              * The coupons that got redeemed with received the code
              */
             coupons: /**
-             * The coupon configuration
+             * The base for the coupon entity without promo codes
              * example:
              * {
-             *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "_schema": "coupon",
-             *   "_org": "org_12345",
-             *   "_created_at": "2024-01-15T10:00:00.000Z",
-             *   "_updated_at": "2024-01-20T12:00:00.000Z",
-             *   "_title": "Sample Coupon",
-             *   "name": "Sample Coupon",
-             *   "type": "fixed",
-             *   "fixed_value": 555,
-             *   "fixed_value_currency": "USD",
-             *   "fixed_value_decimal": "5.55",
-             *   "active": true,
-             *   "prices": {
-             *     "$relation": [
-             *       {
-             *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-             *         "_tags": [
-             *           "discount",
-             *           "special"
-             *         ],
-             *         "_schema": "price"
-             *       }
-             *     ]
-             *   }
+             *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
              * }
              */
             CouponWithoutPromoCodes[];
@@ -5194,20 +5343,7 @@ declare namespace Components {
          * the tax configuration
          * example:
          * {
-         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-         *   "type": "VAT",
-         *   "description": "Tax description",
-         *   "active": "true",
-         *   "region": "DE",
-         *   "region_label": "Germany",
-         *   "_org": "123",
-         *   "_schema": "tax",
-         *   "_tags": [
-         *     "example",
-         *     "mock"
-         *   ],
-         *   "_created_at": "2021-02-09T12:41:43.662Z",
-         *   "_updated_at": "2021-02-09T12:41:43.662Z"
+         *   "$ref": "#/components/examples/tax/value"
          * }
          */
         export interface Tax {
@@ -5259,20 +5395,7 @@ declare namespace Components {
              * the tax configuration
              * example:
              * {
-             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-             *   "type": "VAT",
-             *   "description": "Tax description",
-             *   "active": "true",
-             *   "region": "DE",
-             *   "region_label": "Germany",
-             *   "_org": "123",
-             *   "_schema": "tax",
-             *   "_tags": [
-             *     "example",
-             *     "mock"
-             *   ],
-             *   "_created_at": "2021-02-09T12:41:43.662Z",
-             *   "_updated_at": "2021-02-09T12:41:43.662Z"
+             *   "$ref": "#/components/examples/tax/value"
              * }
              */
             Tax;
@@ -5309,20 +5432,7 @@ declare namespace Components {
              * the tax configuration
              * example:
              * {
-             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-             *   "type": "VAT",
-             *   "description": "Tax description",
-             *   "active": "true",
-             *   "region": "DE",
-             *   "region_label": "Germany",
-             *   "_org": "123",
-             *   "_schema": "tax",
-             *   "_tags": [
-             *     "example",
-             *     "mock"
-             *   ],
-             *   "_created_at": "2021-02-09T12:41:43.662Z",
-             *   "_updated_at": "2021-02-09T12:41:43.662Z"
+             *   "$ref": "#/components/examples/tax/value"
              * }
              */
             Tax;
@@ -5592,6 +5702,19 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $ProductRecommendations {
+        export interface HeaderParameters {
+            "X-Ivy-Org-ID"?: Parameters.XIvyOrgID;
+        }
+        namespace Parameters {
+            export type XIvyOrgID = string;
+        }
+        export type RequestBody = /* Product recommendations request payload */ Components.Schemas.ProductRecommendationSearch;
+        namespace Responses {
+            export type $200 = /* Product recommendations request payload */ Components.Schemas.ProductRecommendationResponse;
+            export type $400 = Components.Schemas.Error;
+        }
+    }
     namespace $SaveCredentials {
         namespace Parameters {
             export type IntegrationId = Components.Schemas.IntegrationId;
@@ -5976,6 +6099,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
+  /**
+   * $productRecommendations - productRecommendations
+   * 
+   * Get a list of product recommendations based on the search parameters.
+   */
+  '$productRecommendations'(
+    parameters?: Parameters<Paths.$ProductRecommendations.HeaderParameters> | null,
+    data?: Paths.$ProductRecommendations.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -6206,6 +6339,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
   }
+  ['/v1/public/product-recommendations']: {
+    /**
+     * $productRecommendations - productRecommendations
+     * 
+     * Get a list of product recommendations based on the search parameters.
+     */
+    'post'(
+      parameters?: Parameters<Paths.$ProductRecommendations.HeaderParameters> | null,
+      data?: Paths.$ProductRecommendations.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -6219,7 +6364,8 @@ export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
 export type AvailabilityResult = Components.Schemas.AvailabilityResult;
 export type AverageMarketPriceRecord = Components.Schemas.AverageMarketPriceRecord;
 export type AverageMarketPriceResult = Components.Schemas.AverageMarketPriceResult;
-export type BaseCoupon = Components.Schemas.BaseCoupon;
+export type BaseCompositePrice = Components.Schemas.BaseCompositePrice;
+export type BaseCouponCommon = Components.Schemas.BaseCouponCommon;
 export type BaseMarketPriceRecord = Components.Schemas.BaseMarketPriceRecord;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
 export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
@@ -6230,6 +6376,8 @@ export type BillingPeriod = Components.Schemas.BillingPeriod;
 export type Cart = Components.Schemas.Cart;
 export type CartDto = Components.Schemas.CartDto;
 export type CashbackAmount = Components.Schemas.CashbackAmount;
+export type CashbackAmounts = Components.Schemas.CashbackAmounts;
+export type CashbackPeriod = Components.Schemas.CashbackPeriod;
 export type CatalogSearch = Components.Schemas.CatalogSearch;
 export type CatalogSearchResult = Components.Schemas.CatalogSearchResult;
 export type CheckoutCart = Components.Schemas.CheckoutCart;
@@ -6252,6 +6400,7 @@ export type CouponItem = Components.Schemas.CouponItem;
 export type CouponWithoutPromoCodes = Components.Schemas.CouponWithoutPromoCodes;
 export type Currency = Components.Schemas.Currency;
 export type Customer = Components.Schemas.Customer;
+export type DiscountAmounts = Components.Schemas.DiscountAmounts;
 export type DynamicTariffInterval = Components.Schemas.DynamicTariffInterval;
 export type DynamicTariffMode = Components.Schemas.DynamicTariffMode;
 export type EntityId = Components.Schemas.EntityId;
@@ -6267,14 +6416,17 @@ export type File = Components.Schemas.File;
 export type GasConcessionType = Components.Schemas.GasConcessionType;
 export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
 export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
+export type HydratedCompositePrice = Components.Schemas.HydratedCompositePrice;
 export type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCredentials;
 export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
 export type IntegrationId = Components.Schemas.IntegrationId;
 export type JourneyContext = Components.Schemas.JourneyContext;
 export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
 export type MetaData = Components.Schemas.MetaData;
+export type NonHydratedCompositePrice = Components.Schemas.NonHydratedCompositePrice;
 export type OAuthCredentials = Components.Schemas.OAuthCredentials;
 export type OAuthIntegration = Components.Schemas.OAuthIntegration;
+export type Offer = Components.Schemas.Offer;
 export type Opportunity = Components.Schemas.Opportunity;
 export type OpportunitySource = Components.Schemas.OpportunitySource;
 export type Order = Components.Schemas.Order;
@@ -6285,6 +6437,7 @@ export type OrderStatus = Components.Schemas.OrderStatus;
 export type PaymentMethod = Components.Schemas.PaymentMethod;
 export type PowerMeterType = Components.Schemas.PowerMeterType;
 export type Price = Components.Schemas.Price;
+export type PriceAmounts = Components.Schemas.PriceAmounts;
 export type PriceComponentRelation = Components.Schemas.PriceComponentRelation;
 export type PriceConditions = Components.Schemas.PriceConditions;
 export type PriceDynamicTariff = Components.Schemas.PriceDynamicTariff;
@@ -6293,7 +6446,7 @@ export type PriceInputMapping = Components.Schemas.PriceInputMapping;
 export type PriceInputMappings = Components.Schemas.PriceInputMappings;
 export type PriceItem = Components.Schemas.PriceItem;
 export type PriceItemDto = Components.Schemas.PriceItemDto;
-export type PriceItemUnion = Components.Schemas.PriceItemUnion;
+export type PriceItemDtoUnion = Components.Schemas.PriceItemDtoUnion;
 export type PriceItems = Components.Schemas.PriceItems;
 export type PriceItemsDto = Components.Schemas.PriceItemsDto;
 export type PriceTier = Components.Schemas.PriceTier;
@@ -6304,6 +6457,9 @@ export type PricingDetailsResponse = Components.Schemas.PricingDetailsResponse;
 export type PricingModel = Components.Schemas.PricingModel;
 export type Product = Components.Schemas.Product;
 export type ProductCategory = Components.Schemas.ProductCategory;
+export type ProductRecommendation = Components.Schemas.ProductRecommendation;
+export type ProductRecommendationResponse = Components.Schemas.ProductRecommendationResponse;
+export type ProductRecommendationSearch = Components.Schemas.ProductRecommendationSearch;
 export type PromoCode = Components.Schemas.PromoCode;
 export type PromoCodeValidationResponse = Components.Schemas.PromoCodeValidationResponse;
 export type Provider = Components.Schemas.Provider;