@epilot/pricing-client 3.28.0 → 3.29.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=i(r(240));t.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}]}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/public/opportunity":{"post":{"deprecated":true,"operationId":"$createOpportunity","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}}},"components":{}}')}},t={},r=function r(i){var a=t[i];if(void 0!==a)return a.exports;var n=t[i]={exports:{}};return e[i].call(n.exports,n,n.exports,r),n.exports}(914),i=exports;for(var a in r)i[a]=r[a];r.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=i(r(240));t.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/pricing:compute":{"post":{"operationId":"$calculatePricingDetails","requestBody":{"required":false,"content":{"application/json":{}}}}},"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID"},{"in":"header","name":"Authorization"}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}]}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}}},"components":{}}')}},t={},r=function r(i){var a=t[i];if(void 0!==a)return a.exports;var n=t[i]={exports:{}};return e[i].call(n.exports,n,n.exports,r),n.exports}(914),i=exports;for(var a in r)i[a]=r[a];r.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -10,6 +10,17 @@
     }
   ],
   "paths": {
+    "/v1/pricing:compute": {
+      "post": {
+        "operationId": "$calculatePricingDetails",
+        "requestBody": {
+          "required": false,
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
+    },
     "/v1/order": {
       "post": {
         "operationId": "createOrder",
@@ -63,8 +74,11 @@
         "parameters": [
           {
             "in": "header",
-            "name": "X-Ivy-Org-ID",
-            "required": true
+            "name": "X-Ivy-Org-ID"
+          },
+          {
+            "in": "header",
+            "name": "Authorization"
           }
         ],
         "requestBody": {
@@ -229,25 +243,6 @@
           }
         ]
       }
-    },
-    "/v1/public/opportunity": {
-      "post": {
-        "deprecated": true,
-        "operationId": "$createOpportunity",
-        "parameters": [
-          {
-            "in": "header",
-            "name": "X-Ivy-Org-ID",
-            "required": true
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {}
-          }
-        }
-      }
     }
   },
   "components": {}

package/dist/openapi.d.ts

@@ -179,7 +179,7 @@ declare namespace Components {
          * Represents a price item
          * example:
          * {
-         *   "$ref": "#/components/examples/price-item"
+         *   "$ref": "#/components/examples/price-item/value"
          * }
          */
         export interface BasePriceItem {
@@ -670,7 +670,37 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price)[];
+            Price | /**
+             * The coupon configuration
+             * 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"
+             *       }
+             *     ]
+             *   }
+             * }
+             */
+            Coupon)[];
         }
         /**
          * The cart checkout request payload
@@ -770,7 +800,7 @@ declare namespace Components {
          * Represents a composite price input to the pricing library.
          * example:
          * {
-         *   "$ref": "#/components/examples/price-item"
+         *   "$ref": "#/components/examples/price-item/value"
          * }
          */
         export interface CompositePriceItem {
@@ -916,7 +946,7 @@ declare namespace Components {
              * Represents a price item
              * example:
              * {
-             *   "$ref": "#/components/examples/price-item"
+             *   "$ref": "#/components/examples/price-item/value"
              * }
              */
             PriceItem[];
@@ -1290,6 +1320,101 @@ declare namespace Components {
             [name: string]: /* The computed price */ ComputedBasePrice;
         }
         export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
+        /**
+         * The coupon configuration
+         * 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"
+         *       }
+         *     ]
+         *   }
+         * }
+         */
+        export interface Coupon {
+            [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;
+            description?: string;
+            type: "fixed" | "percentage";
+            /**
+             * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
+             */
+            percentage_value?: number;
+            /**
+             * 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;
+            active?: 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[];
+        }
         /**
          * 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
@@ -2204,7 +2329,7 @@ declare namespace Components {
          * Represents a price item
          * example:
          * {
-         *   "$ref": "#/components/examples/price-item"
+         *   "$ref": "#/components/examples/price-item/value"
          * }
          */
         export interface PriceItem {
@@ -2745,14 +2870,14 @@ declare namespace Components {
          * Represents a price item
          * example:
          * {
-         *   "$ref": "#/components/examples/price-item"
+         *   "$ref": "#/components/examples/price-item/value"
          * }
          */
         PriceItem | /**
          * Represents a composite price input to the pricing library.
          * example:
          * {
-         *   "$ref": "#/components/examples/price-item"
+         *   "$ref": "#/components/examples/price-item/value"
          * }
          */
         CompositePriceItem)[];
@@ -2789,14 +2914,63 @@ declare namespace Components {
              * Represents a price item
              * example:
              * {
-             *   "$ref": "#/components/examples/price-item"
+             *   "$ref": "#/components/examples/price-item/value"
+             * }
+             */
+            PriceItem | /**
+             * Represents a composite price input to the pricing library.
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price-item/value"
+             * }
+             */
+            CompositePriceItem)[];
+            /**
+             * Total of all items before (discounts or) taxes are applied.
+             */
+            amount_subtotal?: number;
+            /**
+             * Total of all items after (discounts and) taxes are applied.
+             */
+            amount_total?: number;
+            /**
+             * The unit gross amount value.
+             */
+            unit_amount_gross?: number;
+            /**
+             * The unit net amount value.
+             */
+            unit_amount_net?: number;
+            /**
+             * This is the sum of all the price item tax amounts.
+             */
+            amount_tax?: number;
+            total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
+            currency?: /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+        }
+        /**
+         * The result from the calculation of a set of price items.
+         */
+        export interface PricingDetailsResponse {
+            items?: (/**
+             * Represents a price item
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price-item/value"
              * }
              */
             PriceItem | /**
              * Represents a composite price input to the pricing library.
              * example:
              * {
-             *   "$ref": "#/components/examples/price-item"
+             *   "$ref": "#/components/examples/price-item/value"
              * }
              */
             CompositePriceItem)[];
@@ -3401,7 +3575,7 @@ declare namespace Paths {
             line_items?: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ Components.Schemas.PriceItemsDto;
         }
         namespace Responses {
-            export type $200 = /* The result from the calculation of a set of price items. */ Components.Schemas.PricingDetails;
+            export type $200 = /* The result from the calculation of a set of price items. */ Components.Schemas.PricingDetailsResponse;
             export type $400 = Components.Schemas.Error;
         }
     }
@@ -3656,7 +3830,7 @@ export interface OperationMethods {
   /**
    * $calculatePricingDetails - calculatePricingDetails
    * 
-   * Compute price
+   * Computes a set of pricing details that can be persisted on an entity with the pricing capability enabled, e.g: Orders or Contracts.
    */
   '$calculatePricingDetails'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -3765,7 +3939,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$SearchStreets.Responses.$200>
   /**
-   * $computePrice - computePrice
+   * $computePrice - calculatePricingDetails
    * 
    * Returns the price for a given product type based on location and consumption
    */
@@ -3811,7 +3985,7 @@ export interface PathsDictionary {
     /**
      * $calculatePricingDetails - calculatePricingDetails
      * 
-     * Compute price
+     * Computes a set of pricing details that can be persisted on an entity with the pricing capability enabled, e.g: Orders or Contracts.
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -3940,7 +4114,7 @@ export interface PathsDictionary {
   }
   ['/v1/public/integration/{integrationId}/compute-price']: {
     /**
-     * $computePrice - computePrice
+     * $computePrice - calculatePricingDetails
      * 
      * Returns the price for a given product type based on location and consumption
      */

package/dist/openapi.json

@@ -113,7 +113,7 @@
   "paths": {
     "/v1/pricing:compute": {
       "post": {
-        "description": "Compute price",
+        "description": "Computes a set of pricing details that can be persisted on an entity with the pricing capability enabled, e.g: Orders or Contracts.",
         "summary": "calculatePricingDetails",
         "operationId": "$calculatePricingDetails",
         "tags": [
@@ -169,7 +169,124 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/PricingDetails"
+                  "$ref": "#/components/schemas/PricingDetailsResponse"
+                },
+                "example": {
+                  "amount_subtotal": 1000,
+                  "amount_total": 1000,
+                  "amount_tax": 0,
+                  "total_details": {
+                    "amount_tax": 0,
+                    "breakdown": {
+                      "taxes": [
+                        {
+                          "tax": {
+                            "rate": 0
+                          },
+                          "amount": 0
+                        }
+                      ],
+                      "recurrences": [
+                        {
+                          "type": "one_time",
+                          "unit_amount_gross": 1000,
+                          "unit_amount_net": 1000,
+                          "amount_subtotal": 1000,
+                          "amount_total": 1000,
+                          "amount_subtotal_decimal": "10",
+                          "amount_total_decimal": "10",
+                          "amount_tax": 0
+                        }
+                      ],
+                      "recurrencesByTax": [
+                        {
+                          "type": "one_time",
+                          "amount_total": 1000,
+                          "amount_subtotal": 1000,
+                          "amount_tax": 0,
+                          "tax": {
+                            "tax": {
+                              "rate": 0
+                            },
+                            "amount": 0
+                          }
+                        }
+                      ]
+                    }
+                  },
+                  "line_items": [
+                    {
+                      "product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
+                      "price_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
+                      "quantity": 1,
+                      "currency": "EUR",
+                      "_price": {
+                        "description": "Standard price component",
+                        "pricing_model": "per_unit",
+                        "unit_amount_currency": "EUR",
+                        "unit_amount": 1000,
+                        "unit_amount_decimal": "10",
+                        "is_tax_inclusive": true,
+                        "price_display_in_journeys": "show_price",
+                        "active": true,
+                        "variable_price": false,
+                        "type": "one_time",
+                        "billing_period": null,
+                        "billing_duration_amount": null,
+                        "billing_duration_unit": null,
+                        "notice_time_amount": null,
+                        "notice_time_unit": null,
+                        "termination_time_amount": null,
+                        "termination_time_unit": null,
+                        "renewal_duration_amount": null,
+                        "renewal_duration_unit": null,
+                        "price_components": null,
+                        "_tags": [],
+                        "_title": "Standard price component",
+                        "_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
+                        "internal_description": "Standard price component"
+                      },
+                      "_product": {
+                        "type": "product",
+                        "_title": "Product PH",
+                        "name": "Product PH ",
+                        "price_options": {
+                          "$relation": [
+                            {
+                              "entity_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
+                              "_tags": [],
+                              "_schema": "price"
+                            }
+                          ]
+                        },
+                        "_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
+                        "active": true,
+                        "internal_name": "Product PH",
+                        "description": ""
+                      },
+                      "description": "Standard price component",
+                      "unit_amount": 1000,
+                      "unit_amount_net": 1000,
+                      "unit_amount_net_decimal": "10",
+                      "unit_amount_gross": 1000,
+                      "unit_amount_gross_decimal": "10",
+                      "unit_amount_decimal": "10",
+                      "amount_subtotal": 1000,
+                      "amount_total": 1000,
+                      "amount_tax": 0,
+                      "taxes": [
+                        {
+                          "rate": "nontaxable",
+                          "rateValue": 0,
+                          "amount": 0
+                        }
+                      ],
+                      "is_tax_inclusive": true,
+                      "amount_subtotal_decimal": "10",
+                      "amount_total_decimal": "10"
+                    }
+                  ],
+                  "currency": "EUR"
                 }
               }
             }
@@ -1191,7 +1308,7 @@
             "example": "getag"
           }
         ],
-        "summary": "computePrice",
+        "summary": "calculatePricingDetails",
         "tags": [
           "External Integrations API"
         ],
@@ -2546,6 +2663,9 @@
                 },
                 {
                   "$ref": "#/components/schemas/Price"
+                },
+                {
+                  "$ref": "#/components/schemas/Coupon"
                 }
               ]
             }
@@ -3660,7 +3780,7 @@
         "description": "Represents a price item",
         "type": "object",
         "example": {
-          "$ref": "#/components/examples/price-item"
+          "$ref": "#/components/examples/price-item/value"
         },
         "allOf": [
           {
@@ -3814,7 +3934,7 @@
         "description": "Represents a price item",
         "type": "object",
         "example": {
-          "$ref": "#/components/examples/price-item"
+          "$ref": "#/components/examples/price-item/value"
         },
         "properties": {
           "type": {
@@ -4103,6 +4223,51 @@
           }
         }
       },
+      "PricingDetailsResponse": {
+        "type": "object",
+        "description": "The result from the calculation of a set of price items.",
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/PriceItem"
+                },
+                {
+                  "$ref": "#/components/schemas/CompositePriceItem"
+                }
+              ]
+            }
+          },
+          "amount_subtotal": {
+            "type": "integer",
+            "description": "Total of all items before (discounts or) taxes are applied."
+          },
+          "amount_total": {
+            "type": "integer",
+            "description": "Total of all items after (discounts and) taxes are applied."
+          },
+          "unit_amount_gross": {
+            "type": "integer",
+            "description": "The unit gross amount value."
+          },
+          "unit_amount_net": {
+            "type": "integer",
+            "description": "The unit net amount value."
+          },
+          "amount_tax": {
+            "type": "integer",
+            "description": "This is the sum of all the price item tax amounts."
+          },
+          "total_details": {
+            "$ref": "#/components/schemas/TotalDetails"
+          },
+          "currency": {
+            "$ref": "#/components/schemas/Currency"
+          }
+        }
+      },
       "BillingPeriod": {
         "type": "string",
         "enum": [
@@ -4536,6 +4701,147 @@
           }
         }
       },
+      "Coupon": {
+        "type": "object",
+        "description": "The coupon configuration",
+        "additionalProperties": true,
+        "required": [
+          "name",
+          "type",
+          "_id",
+          "_title",
+          "_org",
+          "_schema",
+          "_created_at",
+          "_updated_at"
+        ],
+        "properties": {
+          "_id": {
+            "$ref": "#/components/schemas/EntityId",
+            "readOnly": true
+          },
+          "_title": {
+            "type": "string",
+            "description": "The auto-generated title for the title",
+            "readOnly": true
+          },
+          "_org": {
+            "type": "string",
+            "description": "Organization Id the entity belongs to",
+            "readOnly": true
+          },
+          "_schema": {
+            "type": "string",
+            "enum": [
+              "coupon"
+            ],
+            "readOnly": true,
+            "description": "The schema of the entity, for coupons it is always `coupon`"
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "_created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "The creation date for the opportunity"
+          },
+          "_updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "The date the coupon was last updated"
+          },
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "fixed",
+              "percentage"
+            ]
+          },
+          "percentage_value": {
+            "type": "number",
+            "description": "Use if type is set to percentage. The percentage to be discounted, represented as a whole integer."
+          },
+          "fixed_value": {
+            "description": "Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.",
+            "type": "number"
+          },
+          "fixed_value_decimal": {
+            "description": "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.",
+            "type": "string"
+          },
+          "fixed_value_currency": {
+            "description": "Use if type is set to fixed. Three-letter ISO currency code, in lowercase.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/Currency"
+              }
+            ]
+          },
+          "active": {
+            "type": "boolean"
+          },
+          "prices": {
+            "description": "The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.",
+            "oneOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "$relation": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/EntityRelation"
+                    }
+                  }
+                }
+              },
+              {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/Price"
+                }
+              }
+            ]
+          }
+        },
+        "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"
+              }
+            ]
+          }
+        }
+      },
       "PriceTier": {
         "type": "object",
         "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.28.0",
+  "version": "3.29.0",
   "description": "Client for epilot Pricing APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",