feat: add metered quantity field (#2630)

Author: turip

api/api.gen.go

@@ -5703,6 +5703,8 @@ export interface components {
       rateCard?: components['schemas']['InvoiceUsageBasedRateCard']
       /** @description The quantity of the item being sold. */
       readonly quantity?: components['schemas']['Numeric']
+      /** @description The quantity of the item that has been metered for the period before any discounts were applied. */
+      readonly meteredQuantity?: components['schemas']['Numeric']
       /** @description The quantity of the item used in before this line's period.
        *
        *     It is non-zero in case of progressive billing, when this shows how much of the usage was already billed. */

api/client/go/client.gen.go

@@ -15466,6 +15466,11 @@ components:
             - $ref: '#/components/schemas/Numeric'
           description: The quantity of the item being sold.
           readOnly: true
+        meteredQuantity:
+          allOf:
+            - $ref: '#/components/schemas/Numeric'
+          description: The quantity of the item that has been metered for the period before any discounts were applied.
+          readOnly: true
         preLinePeriodQuantity:
           allOf:
             - $ref: '#/components/schemas/Numeric'

api/client/javascript/src/client/schemas.ts

@@ -15540,6 +15540,11 @@ components:
             - $ref: '#/components/schemas/Numeric'
           description: The quantity of the item being sold.
           readOnly: true
+        meteredQuantity:
+          allOf:
+            - $ref: '#/components/schemas/Numeric'
+          description: The quantity of the item that has been metered for the period before any discounts were applied.
+          readOnly: true
         preLinePeriodQuantity:
           allOf:
             - $ref: '#/components/schemas/Numeric'

api/openapi.cloud.yaml

@@ -748,6 +748,12 @@ model InvoiceUsageBasedLine {
   @visibility(Lifecycle.Read)
   quantity?: Numeric;
 
+  /**
+   * The quantity of the item that has been metered for the period before any discounts were applied.
+   */
+  @visibility(Lifecycle.Read)
+  meteredQuantity?: Numeric;
+
   /**
    * The quantity of the item used in before this line's period.
    *

api/openapi.yaml

@@ -203,6 +203,7 @@ func (a *adapter) mapInvoiceLineWithoutReferences(dbLine *db.BillingInvoiceLine)
 			FeatureKey:            ubpLine.FeatureKey,
 			Price:                 ubpLine.Price,
 			Quantity:              dbLine.Quantity,
+			MeteredQuantity:       ubpLine.MeteredQuantity,
 			PreLinePeriodQuantity: ubpLine.PreLinePeriodQuantity,
 		}
 	default:

api/spec/src/billing/invoices/invoice.tsp

@@ -316,7 +316,8 @@ func (a *adapter) upsertUsageBasedConfig(ctx context.Context, lineDiffs diff[*bi
 				SetPrice(line.UsageBased.Price).
 				SetFeatureKey(line.UsageBased.FeatureKey).
 				SetID(line.UsageBased.ConfigID).
-				SetNillablePreLinePeriodQuantity(line.UsageBased.PreLinePeriodQuantity)
+				SetNillablePreLinePeriodQuantity(line.UsageBased.PreLinePeriodQuantity).
+				SetNillableMeteredQuantity(line.UsageBased.MeteredQuantity)
 
 			return create, nil
 		},

openmeter/billing/adapter/invoicelinemapper.go

@@ -377,6 +377,7 @@ func mapUsageBasedLineToAPI(line *billing.Line) (api.InvoiceLine, error) {
 		TaxConfig: mapTaxConfigToAPI(line.TaxConfig),
 
 		FeatureKey:            lo.ToPtr(line.UsageBased.FeatureKey),
+		MeteredQuantity:       decimalPtrToStringPtr(line.UsageBased.MeteredQuantity),
 		Quantity:              decimalPtrToStringPtr(line.UsageBased.Quantity),
 		PreLinePeriodQuantity: decimalPtrToStringPtr(line.UsageBased.PreLinePeriodQuantity),
 		Price:                 lo.ToPtr(price),

openmeter/billing/adapter/invoicelines.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/openmeterio/openmeter/openmeter/productcatalog"
 	"github.com/openmeterio/openmeter/pkg/currencyx"
+	"github.com/openmeterio/openmeter/pkg/equal"
 	"github.com/openmeterio/openmeter/pkg/models"
 )
 
@@ -702,6 +703,7 @@ type UsageBasedLine struct {
 	Price                 *Price                 `json:"price"`
 	FeatureKey            string                 `json:"featureKey"`
 	Quantity              *alpacadecimal.Decimal `json:"quantity"`
+	MeteredQuantity       *alpacadecimal.Decimal `json:"meteredQuantity,omitempty"`
 	PreLinePeriodQuantity *alpacadecimal.Decimal `json:"preLinePeriodQuantity,omitempty"`
 }
 
@@ -710,7 +712,27 @@ func (i UsageBasedLine) Equal(other *UsageBasedLine) bool {
 		return false
 	}
 
-	return reflect.DeepEqual(i, *other)
+	if !i.Price.Equal(other.Price) {
+		return false
+	}
+
+	if i.FeatureKey != other.FeatureKey {
+		return false
+	}
+
+	if !equal.PtrEqual(i.Quantity, other.Quantity) {
+		return false
+	}
+
+	if !equal.PtrEqual(i.MeteredQuantity, other.MeteredQuantity) {
+		return false
+	}
+
+	if !equal.PtrEqual(i.PreLinePeriodQuantity, other.PreLinePeriodQuantity) {
+		return false
+	}
+
+	return true
 }
 
 func (i UsageBasedLine) Clone() *UsageBasedLine {

openmeter/billing/httpdriver/invoiceline.go

@@ -199,6 +199,8 @@ func (l *usageBasedLine) SnapshotQuantity(ctx context.Context, invoice *billing.
 		return err
 	}
 
+	// MeteredQuantity is not mutable by the price mutators, that's why we have this redundancy
+	l.line.UsageBased.MeteredQuantity = lo.ToPtr(usage.LinePeriodQty)
 	l.line.UsageBased.Quantity = lo.ToPtr(usage.LinePeriodQty)
 	l.line.UsageBased.PreLinePeriodQuantity = lo.ToPtr(usage.PreLinePeriodQty)