Add support for pricing units (#328)

Author: floganz

lago_python_client/models/charge.py

@@ -12,6 +12,11 @@ class ChargeFilter(BaseModel):
     values: Optional[Dict[str, List[str]]]
 
 
+class AppliedPricingUnit(BaseModel):
+    code: Optional[str]
+    conversion_rate: Optional[float]
+
+
 class ChargeFilters(BaseModel):
     __root__: List[ChargeFilter]
 
@@ -29,6 +34,7 @@ class Charge(BaseModel):
     properties: Optional[Dict[str, Any]]
     filters: Optional[ChargeFilters]
     tax_codes: Optional[List[str]]
+    applied_pricing_unit: Optional[AppliedPricingUnit]
 
 
 class Charges(BaseModel):

lago_python_client/models/customer_usage.py

@@ -12,12 +12,19 @@ class Metric(BaseModel):
     aggregation_type: str
 
 
+class PricingUnitDetails(BaseModel):
+    amount_cents: int
+    short_name: str
+    conversion_rate: float
+
+
 class ChargeFilterUsage(BaseModel):
     invoice_display_name: Optional[str]
     values: Dict[str, List[str]]
     units: str
     amount_cents: int
     events_count: int
+    pricing_unit_details: Optional[PricingUnitDetails]
 
 
 class ChargeObject(BaseModel):
@@ -32,6 +39,7 @@ class GroupedUsage(BaseModel):
     units: float
     grouped_by: Dict[str, str]
     filters: List[ChargeFilterUsage]
+    pricing_unit_details: Optional[PricingUnitDetails]
 
 
 class ChargeUsage(BaseModel):
@@ -43,6 +51,7 @@ class ChargeUsage(BaseModel):
     billable_metric: Metric
     filters: List[ChargeFilterUsage]
     grouped_usage: Optional[List[GroupedUsage]]
+    pricing_unit_details: Optional[PricingUnitDetails]
 
 
 class CustomerUsageResponse(BaseResponseModel):

lago_python_client/models/fee.py

@@ -26,6 +26,17 @@ class FeeAppliedTaxes(BaseResponseModel):
     __root__: List[FeeAppliedTax]
 
 
+class PricingUnitDetails(BaseResponseModel):
+    lago_pricing_unit_id: Optional[str]
+    pricing_unit_code: Optional[str]
+    short_name: Optional[str]
+    amount_cents: Optional[int]
+    precise_amount_cents: Optional[str]
+    unit_amount_cents: Optional[int]
+    precise_unit_amount: Optional[str]
+    conversion_rate: Optional[float]
+
+
 class FeeResponse(BaseResponseModel):
     lago_id: Optional[str]
     lago_charge_id: Optional[str]
@@ -59,6 +70,7 @@ class FeeResponse(BaseResponseModel):
     from_date: Optional[str]
     to_date: Optional[str]
     amount_details: Optional[Dict[str, Any]]
+    pricing_unit_details: Optional[PricingUnitDetails]
     billing_entity_code: Optional[str]
 
     item: Optional[InvoiceItemResponse]

tests/fixtures/customer_past_usage.json

@@ -25,6 +25,11 @@
             "code": "usage_metric",
             "aggregation_type": "sum"
           },
+          "pricing_unit_details": {
+            "amount_cents": 123,
+            "short_name": "CR",
+            "conversion_rate": 1.0
+          },
           "filters": [
             {
               "units": "3.0",
@@ -34,6 +39,11 @@
                 "country": [
                   "france"
                 ]
+              },
+              "pricing_unit_details": {
+                "amount_cents": 123,
+                "short_name": "CR",
+                "conversion_rate": 1.0
               }
             }
           ]

tests/fixtures/customer_usage.json

@@ -25,6 +25,11 @@
           "code": "usage_metric",
           "aggregation_type": "sum"
         },
+        "pricing_unit_details": {
+          "amount_cents": 123,
+          "short_name": "CR",
+          "conversion_rate": 1.0
+        },
         "filters": [
           {
             "units": "3.0",
@@ -34,6 +39,11 @@
               "country": [
                 "france"
               ]
+            },
+            "pricing_unit_details": {
+              "amount_cents": 123,
+              "short_name": "CR",
+              "conversion_rate": 1.0
             }
           }
         ],
@@ -45,6 +55,11 @@
             "grouped_by": {
               "agent_name": "aragorn"
             },
+            "pricing_unit_details": {
+              "amount_cents": 456,
+              "short_name": "CR",
+              "conversion_rate": 1.2
+            },
             "filters": [
               {
                 "units": "3.0",
@@ -54,7 +69,8 @@
                   "country": [
                     "france"
                   ]
-                }
+                },
+                "pricing_unit_details": null
               }
             ]
           }

tests/fixtures/fee.json

@@ -26,6 +26,16 @@
     "total_amount_currency": "EUR",
     "units": "10.0",
     "events_count": 10,
+    "pricing_unit_details": {
+      "lago_pricing_unit_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
+      "pricing_unit_code": "unit_code",
+      "short_name": "UC",
+      "amount_cents": 120,
+      "precise_amount_cents": "120.00",
+      "unit_amount_cents": 12,
+      "precise_unit_amount": "12.00",
+      "conversion_rate": 1.0
+    },
     "applied_taxes": [
       {
         "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",

tests/fixtures/fees.json

@@ -26,6 +26,16 @@
       "total_amount_currency": "EUR",
       "units": "1.0",
       "events_count": 1,
+      "pricing_unit_details": {
+        "lago_pricing_unit_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
+        "pricing_unit_code": "unit_code",
+        "short_name": "UN",
+        "amount_cents": 120,
+        "precise_amount_cents": "120.00",
+        "unit_amount_cents": 120,
+        "precise_unit_amount": "120.00",
+        "conversion_rate": 1.0
+      },
       "applied_taxes": [
         {
           "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",