@epilot/pricing-client 2.1.2 → 2.1.5

package/dist/openapi.d.ts

@@ -157,6 +157,223 @@ declare namespace Components {
                 };
             }[];
         }
+        /**
+         * Represents a price item
+         * example:
+         * {
+         *   "$ref": "#/components/examples/price-item"
+         * }
+         */
+        export interface BasePriceItem {
+            /**
+             * 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;
+            /**
+             * Total before any (discounts or) taxes are applied.
+             */
+            amount_subtotal?: number;
+            /**
+             * Net unit amount without taxes or discounts.
+             */
+            unit_amount_net?: number;
+            /**
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             */
+            unit_amount_decimal?: string;
+            /**
+             * Total after (discounts and) taxes.
+             */
+            amount_total?: number;
+            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;
+            /**
+             * 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.
+             */
+            _price?: /* The price snapshot data. */ /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
+            _product?: /**
+             * The product entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            Product;
+            /**
+             * The taxes applied to the price item.
+             */
+            taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmount)[];
+            /**
+             * The sum of amounts of the price items by recurrence.
+             */
+            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
+        }
+        /**
+         * 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;
+            /**
+             * The quantity of products being purchased.
+             */
+            quantity?: number;
+            /**
+             * 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 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.
+             */
+            is_composite_price?: boolean;
+            /**
+             * The snapshot of the product.
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            _product?: {
+                [name: string]: any;
+                /**
+                 * 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;
+            };
+        }
         export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
         /**
          * Supports shopping for products and services until ready for checkout.
@@ -373,7 +590,14 @@ declare namespace Components {
             /**
              * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
              */
-            price_components?: {
+            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[];
             };
             /**
@@ -387,6 +611,10 @@ declare namespace Components {
              * EUR
              */
             Currency;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
             /**
              * The price creation date
              */
@@ -491,10 +719,7 @@ declare namespace Components {
              * }
              */
             CompositePrice;
-            /**
-             * The product snapshot data.
-             */
-            _product?: /* The product snapshot data. */ /**
+            _product?: /**
              * The product entity
              * example:
              * {
@@ -543,14 +768,6 @@ declare namespace Components {
              * The id of the price.
              */
             price_id?: string;
-            /**
-             * The unit amount value
-             */
-            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 taxes applied to the price item.
              */
@@ -559,14 +776,102 @@ declare namespace Components {
              * The taxes applied to the price item.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
-            _price?: /**
-             * The price entity schema for simple pricing
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * The snapshot of the product.
              * example:
              * {
-             *   "$ref": "#/components/examples/price"
+             *   "$ref": "#/components/examples/product"
              * }
              */
-            Price | /**
+            _product?: {
+                [name: string]: any;
+                /**
+                 * 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;
+            };
+            /**
+             * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
+             */
+            item_components?: /* Represents a price input to the pricing library. */ PriceItemDto[];
+            _price?: /**
              * The price entity schema for dynamic pricing
              * example:
              * {
@@ -574,18 +879,6 @@ declare namespace Components {
              * }
              */
             CompositePrice;
-            _product?: /**
-             * The product entity
-             * example:
-             * {
-             *   "$ref": "#/components/examples/product"
-             * }
-             */
-            Product;
-            /**
-             * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
-             */
-            item_components?: /* Represents a valid price item from a client. */ PriceItemDto[];
         }
         /**
          * Three-letter ISO currency code, in lowercase. Must be a supported currency.
@@ -606,6 +899,36 @@ declare namespace Components {
             email?: string;
             phone?: string;
         }
+        export type EntityId = string; // uuid
+        /**
+         * 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"
+         * }
+         */
+        export interface EntityItem {
+            _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
+        }
         export interface EntityRelation {
             [name: string]: any;
             entity_id?: string;
@@ -616,6 +939,14 @@ declare namespace Components {
              * Error message
              */
             message: string;
+            /**
+             * The HTTP status code
+             */
+            status?: number;
+            /**
+             * The cause of the error (visible for bad requests - http 400)
+             */
+            cause?: string;
         }
         export interface File {
             [name: string]: any;
@@ -1077,6 +1408,10 @@ declare namespace Components {
              * Whether the price can be used for new purchases.
              */
             active?: boolean;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
             /**
              * Describes how to compute the price per period. Either `per_unit` or `tiered`.
              * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
@@ -1104,9 +1439,30 @@ declare namespace Components {
             /**
              * The default tax rate applied to the price
              */
-            tax?: {
+            tax?: /* The default tax rate applied to the price */ {
                 $relation?: EntityRelation[];
-            };
+            } | /**
+             * the tax configuration
+             * example:
+             * {
+             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+             *   "type": "VAT",
+             *   "description": "Tax description",
+             *   "behavior": "Exclusive",
+             *   "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"
+             * }
+             */
+            Tax[];
             /**
              * Specifies whether the price is considered `inclusive` of taxes or `exclusive` of taxes.
              * One of `inclusive`, `exclusive`, or `unspecified`.
@@ -1216,14 +1572,6 @@ declare namespace Components {
              *
              */
             quantity?: number;
-            item?: /**
-             * The price entity schema for simple pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price"
-             * }
-             */
-            Price;
             /**
              * An arbitrary set of tags attached to the composite price - component relation
              */
@@ -1308,10 +1656,7 @@ declare namespace Components {
              * }
              */
             CompositePrice;
-            /**
-             * The product snapshot data.
-             */
-            _product?: /* The product snapshot data. */ /**
+            _product?: /**
              * The product entity
              * example:
              * {
@@ -1327,9 +1672,13 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
+            /**
+             * 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";
         }
         /**
-         * Represents a valid price item from a client.
+         * Represents a price input to the pricing library.
          */
         export interface PriceItemDto {
             metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
@@ -1349,14 +1698,6 @@ declare namespace Components {
              * The id of the price.
              */
             price_id?: string;
-            /**
-             * The unit amount value
-             */
-            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 taxes applied to the price item.
              */
@@ -1365,25 +1706,275 @@ declare namespace Components {
              * The taxes applied to the price item.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
-            _price?: /**
-             * The price entity schema for simple pricing
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * The snapshot of the product.
              * example:
              * {
-             *   "$ref": "#/components/examples/price"
+             *   "$ref": "#/components/examples/product"
              * }
              */
-            Price;
+            _product?: {
+                [name: string]: any;
+                /**
+                 * 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 product linked to the price item.
+             * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
-            _product?: /**
-             * The product entity
+            type?: "one_time" | "recurring";
+            /**
+             * The unit amount value
+             */
+            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 snapshot of the price linked to the price item.
              * example:
              * {
-             *   "$ref": "#/components/examples/product"
+             *   "$ref": "#/components/examples/price"
              * }
              */
-            Product;
+            _price?: {
+                [name: string]: any;
+                /**
+                 * Whether the price can be used for new purchases.
+                 */
+                active?: boolean;
+                /**
+                 * The flag for prices that contain price components.
+                 */
+                is_composite_price?: boolean;
+                /**
+                 * Describes how to compute the price per period. Either `per_unit` or `tiered`.
+                 * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
+                 * - `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
+                 *
+                 * ⚠️ Tiered pricing is **not supported** yet.
+                 *
+                 */
+                billing_scheme?: "per_unit";
+                /**
+                 * A brief description of the price.
+                 */
+                description?: string;
+                /**
+                 * The default tax rate applicable to the product.
+                 * This field is deprecated, use the new `tax` attribute.
+                 *
+                 */
+                sales_tax?: /**
+                 * The default tax rate applicable to the product.
+                 * This field is deprecated, use the new `tax` attribute.
+                 *
+                 */
+                SalesTax;
+                /**
+                 * The default tax rate applied to the price
+                 */
+                tax?: /* The default tax rate applied to the price */ {
+                    $relation?: EntityRelation[];
+                } | /**
+                 * the tax configuration
+                 * example:
+                 * {
+                 *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+                 *   "type": "VAT",
+                 *   "description": "Tax description",
+                 *   "behavior": "Exclusive",
+                 *   "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"
+                 * }
+                 */
+                Tax[];
+                /**
+                 * Specifies whether the price is considered `inclusive` of taxes or `exclusive` of taxes.
+                 * One of `inclusive`, `exclusive`, or `unspecified`.
+                 *
+                 */
+                tax_behavior?: "inclusive" | "exclusive";
+                /**
+                 * Defines the tiered pricing type of the price.
+                 */
+                tiers_mode?: "standard";
+                /**
+                 * 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";
+                /**
+                 * For recurring prices `billing_period` defines the default extent of the recurrence.
+                 */
+                billing_period?: /* For recurring prices `billing_period` defines the default extent of the recurrence. */ BillingPeriod;
+                /**
+                 * The unit amount in cents to be charged, represented as a whole integer if possible.
+                 */
+                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;
+                /**
+                 * 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;
+                /**
+                 * Defines the way the price amount is display in epilot journeys.
+                 */
+                price_display_in_journeys?: "show_price" | "show_as_starting_price" | "show_as_on_request";
+                /**
+                 * 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";
+                /**
+                 * 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 price
+                 */
+                _tags?: string[];
+            };
         }
         /**
          * Tracks a set of product prices, quantities, (discounts) and taxes.
@@ -1406,7 +1997,7 @@ declare namespace Components {
         /**
          * A valid set of product prices, quantities, (discounts) and taxes from a client.
          */
-        export type PriceItemsDto = (/* Represents a valid price item from a client. */ PriceItemDto)[];
+        export type PriceItemsDto = (/* Represents a price input to the pricing library. */ PriceItemDto)[];
         /**
          * The result from the calculation of a set of price items.
          */
@@ -1523,7 +2114,7 @@ declare namespace Components {
             /**
              * The price type.
              */
-            type: string;
+            type?: string;
             /**
              * The price billing period.
              */
@@ -1548,7 +2139,7 @@ declare namespace Components {
             /**
              * The price type.
              */
-            type: string;
+            type?: string;
             /**
              * The price billing period.
              */
@@ -1569,13 +2160,44 @@ declare namespace Components {
         export type SalesTax = "nontaxable" | "reduced" | "standard";
         /**
          * the tax configuration
+         * example:
+         * {
+         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+         *   "type": "VAT",
+         *   "description": "Tax description",
+         *   "behavior": "Exclusive",
+         *   "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"
+         * }
          */
         export interface Tax {
             [name: string]: any;
+            _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
             type: "VAT" | "GST" | "Custom";
             description?: string;
             rate: number;
-            behavior: "Exclusive" | "Inclusive";
+            behavior: "Exclusive" | "Inclusive" | "exclusive" | "inclusive";
             active?: boolean;
             region?: string;
             region_label?: string;
@@ -1589,26 +2211,98 @@ declare namespace Components {
              */
             amount?: number;
             /**
-             * The tax rate applied.
+             * The tax rate applied. With the release of the tax management feature this field is being deprecated in favor of the tax field.
              */
             rate?: string;
+            /**
+             * The tax rate value applied (represented as an integer percentage, e.g, 19 or 7).
+             * With the release of the tax management feature this field is being deprecated in favor of the tax field.
+             *
+             * example:
+             * 19
+             */
+            rateValue?: number;
             /**
              * The tax applied.
              */
-            tax?: /* The tax applied. */ /* the tax configuration */ Tax;
+            tax?: /* The tax applied. */ /**
+             * the tax configuration
+             * example:
+             * {
+             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+             *   "type": "VAT",
+             *   "description": "Tax description",
+             *   "behavior": "Exclusive",
+             *   "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"
+             * }
+             */
+            Tax;
+        }
+        /**
+         * A tax amount associated with a specific tax rate.
+         */
+        export interface TaxAmountBreakdown {
+            /**
+             * The tax amount.
+             */
+            amount?: number;
+            /**
+             * The tax rate applied. With the release of the tax manager feature this field is being deprecated in favor of the tax field.
+             */
+            rate?: string;
+            /**
+             * The tax rate value applied. With the release of the tax manager feature this field is being deprecated in favor of the tax field.
+             */
+            rateValue?: number;
+            tax?: TaxBreakdownInfo;
         }
         /**
          * A valid tax rate from a client.
          */
         export interface TaxAmountDto {
             /**
-             * The tax rate applied.
+             * The deprecated tax rate applied.
+             * This field has been deprecated in favor of the new Tax Management. You should use the new tax fields pointing to a proper tax entity.
+             *
              */
             rate?: string;
-            /**
-             * The tax applied.
+            tax?: /**
+             * the tax configuration
+             * example:
+             * {
+             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+             *   "type": "VAT",
+             *   "description": "Tax description",
+             *   "behavior": "Exclusive",
+             *   "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"
+             * }
              */
-            tax?: /* The tax applied. */ /* the tax configuration */ Tax;
+            Tax;
+        }
+        export interface TaxBreakdownInfo {
+            rate?: number;
+            type?: "VAT" | "GST" | "Custom";
+            _id?: string;
         }
         /**
          * The total details with tax (and discount) aggregated totals.
@@ -1629,7 +2323,7 @@ declare namespace Components {
                 /**
                  * The aggregated price items tax amount per rate.
                  */
-                taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmount)[];
+                taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmountBreakdown)[];
                 /**
                  * The aggregated price items tax amount per rate.
                  */