feat: billing add subscription metadata to lines

openmeterio · Dec 13, 2024 · d8aea7d · d8aea7d
1 parent eba9258
commit d8aea7d
Show file tree

Hide file tree

Showing 43 changed files with 5,036 additions and 1,568 deletions.
diff --git a/api/api.gen.go b/api/api.gen.go
diff --git a/api/client/go/client.gen.go b/api/client/go/client.gen.go
diff --git a/api/openapi.cloud.yaml b/api/openapi.cloud.yaml
@@ -10913,6 +10913,19 @@ components:
           example: 100
           description: The usage in the period
       description: Usage Record
+    IDResource:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          example: 01G65Z755AFWAKHE12NY0CQ9FH
+          pattern: ^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$
+          description: A unique identifier for the resource.
+          title: ID
+          readOnly: true
+      description: IDResource is a resouce with an ID.
     IngestEventsBody:
       anyOf:
         - $ref: '#/components/schemas/Event'
@@ -11335,6 +11348,11 @@ components:
             - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
           description: External IDs of the invoice in other apps such as Stripe.
           readOnly: true
+        subscriptions:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineSubscriptionReference'
+          description: Subscription are the references to the subscritpions that this line is related to.
+          readOnly: true
         type:
           type: string
           enum:
@@ -11601,6 +11619,29 @@ components:
         - detail
         - split
       description: Line status specifies the status of the line.
+    InvoiceLineSubscriptionReference:
+      type: object
+      required:
+        - subscription
+        - phase
+        - item
+      properties:
+        subscription:
+          allOf:
+            - $ref: '#/components/schemas/IDResource'
+          description: The subscription.
+          readOnly: true
+        phase:
+          allOf:
+            - $ref: '#/components/schemas/IDResource'
+          description: The phase of the subscription.
+          readOnly: true
+        item:
+          allOf:
+            - $ref: '#/components/schemas/IDResource'
+          description: The item this line is related to.
+          readOnly: true
+      description: InvoiceLineSubscriptionReference contains the references to the subscriptions that this line is related to.
     InvoiceLineTaxBehavior:
       type: string
       enum:
@@ -11984,6 +12025,11 @@ components:
             - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
           description: External IDs of the invoice in other apps such as Stripe.
           readOnly: true
+        subscriptions:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineSubscriptionReference'
+          description: Subscription are the references to the subscritpions that this line is related to.
+          readOnly: true
         type:
           type: string
           enum:

diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -10603,6 +10603,19 @@ components:
           example: 100
           description: The usage in the period
       description: Usage Record
+    IDResource:
+      type: object
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          example: 01G65Z755AFWAKHE12NY0CQ9FH
+          pattern: ^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$
+          description: A unique identifier for the resource.
+          title: ID
+          readOnly: true
+      description: IDResource is a resouce with an ID.
     IngestEventsBody:
       anyOf:
         - $ref: '#/components/schemas/Event'
@@ -11025,6 +11038,11 @@ components:
             - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
           description: External IDs of the invoice in other apps such as Stripe.
           readOnly: true
+        subscriptions:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineSubscriptionReference'
+          description: Subscription are the references to the subscritpions that this line is related to.
+          readOnly: true
         type:
           type: string
           enum:
@@ -11291,6 +11309,29 @@ components:
         - detail
         - split
       description: Line status specifies the status of the line.
+    InvoiceLineSubscriptionReference:
+      type: object
+      required:
+        - subscription
+        - phase
+        - item
+      properties:
+        subscription:
+          allOf:
+            - $ref: '#/components/schemas/IDResource'
+          description: The subscription.
+          readOnly: true
+        phase:
+          allOf:
+            - $ref: '#/components/schemas/IDResource'
+          description: The phase of the subscription.
+          readOnly: true
+        item:
+          allOf:
+            - $ref: '#/components/schemas/IDResource'
+          description: The item this line is related to.
+          readOnly: true
+      description: InvoiceLineSubscriptionReference contains the references to the subscriptions that this line is related to.
     InvoiceLineTaxBehavior:
       type: string
       enum:
@@ -11674,6 +11715,11 @@ components:
             - $ref: '#/components/schemas/InvoiceLineAppExternalIDs'
           description: External IDs of the invoice in other apps such as Stripe.
           readOnly: true
+        subscriptions:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineSubscriptionReference'
+          description: Subscription are the references to the subscritpions that this line is related to.
+          readOnly: true
         type:
           type: string
           enum:

diff --git a/api/spec/src/billing/invoices/invoice.tsp b/api/spec/src/billing/invoices/invoice.tsp
@@ -580,6 +580,12 @@ model InvoiceLineBase {
    */
   @visibility("read")
   externalIDs?: InvoiceLineAppExternalIDs;
+
+  /**
+   * Subscription are the references to the subscritpions that this line is related to.
+   */
+  @visibility("read")
+  subscriptions?: InvoiceLineSubscriptionReference;
 }
 
 /**
@@ -890,3 +896,27 @@ model InvoiceLineAppExternalIDs {
   @visibility("read")
   Tax?: string;
 }
+
+/**
+ * InvoiceLineSubscriptionReference contains the references to the subscriptions that this line is related to.
+ */
+@friendlyName("InvoiceLineSubscriptionReference")
+model InvoiceLineSubscriptionReference {
+  /**
+   * The subscription.
+   */
+  @visibility("read")
+  subscription: IDResource;
+
+  /**
+   * The phase of the subscription.
+   */
+  @visibility("read")
+  phase: IDResource;
+
+  /**
+   * The item this line is related to.
+   */
+  @visibility("read")
+  item: IDResource;
+}
diff --git a/api/spec/src/types.tsp b/api/spec/src/types.tsp
@@ -78,6 +78,22 @@ model UniqueResource {
   key: Key;
 }
 
+/**
+ * IDResource is a resouce with an ID.
+ */
+// NOTE: this can be used to have a type, that we can later replace with the expanded type if needed without
+// breaking api compatibility
+@friendlyName("IDResource")
+model IDResource {
+  /**
+   * A unique identifier for the resource.
+   */
+  @visibility("read")
+  @example("01G65Z755AFWAKHE12NY0CQ9FH")
+  @summary("ID")
+  id: ULID;
+}
+
 /**
  * Represents common fields of resources.
  */

diff --git a/openmeter/billing/adapter/invoicelinemapper.go b/openmeter/billing/adapter/invoicelinemapper.go
@@ -165,6 +165,14 @@ func (a *adapter) mapInvoiceLineWithoutReferences(dbLine *db.BillingInvoiceLine)
 		},
 	}
 
+	if dbLine.SubscriptionID != nil && dbLine.SubscriptionPhaseID != nil && dbLine.SubscriptionItemID != nil {
+		invoiceLine.Subscription = &billing.SubscriptionReference{
+			SubscriptionID: *dbLine.SubscriptionID,
+			PhaseID:        *dbLine.SubscriptionPhaseID,
+			ItemID:         *dbLine.SubscriptionItemID,
+		}
+	}
+
 	switch dbLine.Type {
 	case billing.InvoiceLineTypeFee:
 		invoiceLine.FlatFee = billing.FlatFeeLine{

diff --git a/openmeter/billing/adapter/invoicelines.go b/openmeter/billing/adapter/invoicelines.go
@@ -102,6 +102,12 @@ func (a *adapter) UpsertInvoiceLines(ctx context.Context, inputIn billing.Upsert
 					// ExternalIDs
 					SetNillableInvoicingAppExternalID(lo.EmptyableToPtr(line.ExternalIDs.Invoicing))
 
+				if line.Subscription != nil {
+					create = create.SetSubscriptionID(line.Subscription.ItemID).
+						SetSubscriptionPhaseID(line.Subscription.PhaseID).
+						SetSubscriptionItemID(line.Subscription.ItemID)
+				}
+
 				if line.TaxConfig != nil {
 					create = create.SetTaxConfig(*line.TaxConfig)
 				}

diff --git a/openmeter/billing/httpdriver/invoiceline.go b/openmeter/billing/httpdriver/invoiceline.go
@@ -504,6 +504,7 @@ func mapFeeLineToAPI(line *billing.Line) (api.InvoiceLine, error) {
 		ExternalIDs: &api.InvoiceLineAppExternalIDs{
 			Invoicing: lo.EmptyableToPtr(line.ExternalIDs.Invoicing),
 		},
+		Subscriptions: mapSubscriptionReferencesToAPI(line.Subscription),
 	}
 
 	out := api.InvoiceLine{}
@@ -564,6 +565,7 @@ func mapUsageBasedLineToAPI(line *billing.Line) (api.InvoiceLine, error) {
 		ExternalIDs: lo.EmptyableToPtr(api.InvoiceLineAppExternalIDs{
 			Invoicing: lo.EmptyableToPtr(line.ExternalIDs.Invoicing),
 		}),
+		Subscriptions: mapSubscriptionReferencesToAPI(line.Subscription),
 	}
 
 	out := api.InvoiceLine{}
@@ -575,6 +577,24 @@ func mapUsageBasedLineToAPI(line *billing.Line) (api.InvoiceLine, error) {
 	return out, nil
 }
 
+func mapSubscriptionReferencesToAPI(optSub *billing.SubscriptionReference) *api.InvoiceLineSubscriptionReference {
+	if optSub == nil {
+		return nil
+	}
+
+	return &api.InvoiceLineSubscriptionReference{
+		Item: api.IDResource{
+			Id: optSub.SubscriptionID,
+		},
+		Phase: api.IDResource{
+			Id: optSub.PhaseID,
+		},
+		Subscription: api.IDResource{
+			Id: optSub.ItemID,
+		},
+	}
+}
+
 func mapDiscountsToAPI(optDiscounts billing.LineDiscounts) *[]api.InvoiceLineDiscount {
 	if optDiscounts.IsAbsent() {
 		return nil

diff --git a/openmeter/billing/invoiceline.go b/openmeter/billing/invoiceline.go
@@ -128,7 +128,8 @@ type LineBase struct {
 
 	TaxConfig *TaxConfig `json:"taxOverrides,omitempty"`
 
-	ExternalIDs LineExternalIDs `json:"externalIDs,omitempty"`
+	ExternalIDs  LineExternalIDs        `json:"externalIDs,omitempty"`
+	Subscription *SubscriptionReference `json:"subscription,omitempty"`
 
 	Totals Totals `json:"totals"`
 }
@@ -188,6 +189,12 @@ func (i LineBase) Clone(line *Line) LineBase {
 	return out
 }
 
+type SubscriptionReference struct {
+	SubscriptionID string `json:"subscriptionID"`
+	PhaseID        string `json:"phaseID"`
+	ItemID         string `json:"itemID"`
+}
+
 type LineExternalIDs struct {
 	Invoicing string `json:"invoicing,omitempty"`
 }