feat: add discount reason

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

@@ -4752,6 +4752,11 @@ export interface components {
       /** @description Invoice a gathering invoice */
       readonly invoice?: components['schemas']['InvoiceAvailableActionInvoiceDetails']
     }
+    /**
+     * @description Reason code.
+     * @enum {string}
+     */
+    InvoiceDiscountReason: 'maximum_spend' | 'ratecard_discount'
     /** @description InvoiceDocumentRef is used to describe a reference to an existing document (invoice). */
     InvoiceDocumentRef: components['schemas']['CreditNoteOriginalInvoiceRef']
     /**
@@ -5108,9 +5113,13 @@ export interface components {
        */
       readonly id: string
       /** @description Reason code. */
-      readonly code?: string
+      readonly reason: components['schemas']['InvoiceDiscountReason']
       /** @description Text description as to why the discount was applied. */
       readonly description?: string
+      /** @description External IDs of the invoice in other apps such as Stripe. */
+      readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds']
+      /** @description The discount from the rate card this discount is based on. */
+      readonly rateCardDiscount?: components['schemas']['Discount']
       /**
        * Amount in the currency of the invoice
        * @description Fixed discount amount to apply (calculated if percent present).
@@ -5121,10 +5130,6 @@ export interface components {
        * @enum {string}
        */
       type: 'amount'
-      /** @description The discount from the rate card this discount is based on. */
-      readonly rateCardDiscount?: components['schemas']['Discount']
-      /** @description External IDs of the invoice in other apps such as Stripe. */
-      readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds']
     }
     /** @description InvoiceLineDiscountUsage represents an usage-based discount applied to the line.
      *
@@ -5157,9 +5162,13 @@ export interface components {
        */
       readonly id: string
       /** @description Reason code. */
-      readonly code?: string
+      readonly reason: components['schemas']['InvoiceDiscountReason']
       /** @description Text description as to why the discount was applied. */
       readonly description?: string
+      /** @description External IDs of the invoice in other apps such as Stripe. */
+      readonly externalIds?: components['schemas']['InvoiceLineAppExternalIds']
+      /** @description The discount from the rate card this discount is based on. */
+      readonly rateCardDiscount?: components['schemas']['Discount']
       /**
        * Usage quantity in the unit of the underlying meter
        * @description The usage to apply.
@@ -5177,8 +5186,6 @@ export interface components {
        * @enum {string}
        */
       type: 'usage'
-      /** @description The discount from the rate card this discount is based on. */
-      readonly rateCardDiscount?: components['schemas']['Discount']
     }
     /**
      * @description InvoiceLineManagedBy specifies who manages the line.
@@ -9030,6 +9037,8 @@ export type InvoiceAvailableActionInvoiceDetails =
   components['schemas']['InvoiceAvailableActionInvoiceDetails']
 export type InvoiceAvailableActions =
   components['schemas']['InvoiceAvailableActions']
+export type InvoiceDiscountReason =
+  components['schemas']['InvoiceDiscountReason']
 export type InvoiceDocumentRef = components['schemas']['InvoiceDocumentRef']
 export type InvoiceDocumentRefType =
   components['schemas']['InvoiceDocumentRefType']

api/openapi.cloud.yaml

@@ -13813,6 +13813,12 @@ components:
           description: Invoice a gathering invoice
           readOnly: true
       description: InvoiceAvailableActions represents the actions that can be performed on the invoice.
+    InvoiceDiscountReason:
+      type: string
+      enum:
+        - maximum_spend
+        - ratecard_discount
+      description: Reason code.
     InvoiceDocumentRef:
       type: object
       allOf:
@@ -14276,6 +14282,7 @@ components:
         - createdAt
         - updatedAt
         - id
+        - reason
         - amount
         - type
       properties:
@@ -14306,14 +14313,25 @@ components:
           description: ID of the charge or discount.
           example: 01G65Z755AFWAKHE12NY0CQ9FH
           readOnly: true
-        code:
-          type: string
+        reason:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceDiscountReason'
           description: Reason code.
           readOnly: true
         description:
           type: string
           description: Text description as to why the discount was applied.
           readOnly: true
+        externalIds:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIds'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
+        rateCardDiscount:
+          allOf:
+            - $ref: '#/components/schemas/Discount'
+          description: The discount from the rate card this discount is based on.
+          readOnly: true
         amount:
           allOf:
             - $ref: '#/components/schemas/Numeric'
@@ -14326,23 +14344,14 @@ components:
             - amount
           description: The type of the discount.
           readOnly: true
-        rateCardDiscount:
-          allOf:
-            - $ref: '#/components/schemas/Discount'
-          description: The discount from the rate card this discount is based on.
-          readOnly: true
-        externalIds:
-          allOf:
-            - $ref: '#/components/schemas/InvoiceLineAppExternalIds'
-          description: External IDs of the invoice in other apps such as Stripe.
-          readOnly: true
       description: InvoiceLineDiscountAmount represents an amount deducted from the line, and will be applied before taxes.
     InvoiceLineDiscountUsage:
       type: object
       required:
         - createdAt
         - updatedAt
         - id
+        - reason
         - quantity
         - type
       properties:
@@ -14373,14 +14382,25 @@ components:
           description: ID of the charge or discount.
           example: 01G65Z755AFWAKHE12NY0CQ9FH
           readOnly: true
-        code:
-          type: string
+        reason:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceDiscountReason'
           description: Reason code.
           readOnly: true
         description:
           type: string
           description: Text description as to why the discount was applied.
           readOnly: true
+        externalIds:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIds'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
+        rateCardDiscount:
+          allOf:
+            - $ref: '#/components/schemas/Discount'
+          description: The discount from the rate card this discount is based on.
+          readOnly: true
         quantity:
           allOf:
             - $ref: '#/components/schemas/Numeric'
@@ -14402,11 +14422,6 @@ components:
             - usage
           description: The type of the discount.
           readOnly: true
-        rateCardDiscount:
-          allOf:
-            - $ref: '#/components/schemas/Discount'
-          description: The discount from the rate card this discount is based on.
-          readOnly: true
       description: |-
         InvoiceLineDiscountUsage represents an usage-based discount applied to the line.
 

api/openapi.yaml

@@ -13887,6 +13887,12 @@ components:
           description: Invoice a gathering invoice
           readOnly: true
       description: InvoiceAvailableActions represents the actions that can be performed on the invoice.
+    InvoiceDiscountReason:
+      type: string
+      enum:
+        - maximum_spend
+        - ratecard_discount
+      description: Reason code.
     InvoiceDocumentRef:
       type: object
       allOf:
@@ -14350,6 +14356,7 @@ components:
         - createdAt
         - updatedAt
         - id
+        - reason
         - amount
         - type
       properties:
@@ -14380,14 +14387,25 @@ components:
           description: ID of the charge or discount.
           example: 01G65Z755AFWAKHE12NY0CQ9FH
           readOnly: true
-        code:
-          type: string
+        reason:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceDiscountReason'
           description: Reason code.
           readOnly: true
         description:
           type: string
           description: Text description as to why the discount was applied.
           readOnly: true
+        externalIds:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIds'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
+        rateCardDiscount:
+          allOf:
+            - $ref: '#/components/schemas/Discount'
+          description: The discount from the rate card this discount is based on.
+          readOnly: true
         amount:
           allOf:
             - $ref: '#/components/schemas/Numeric'
@@ -14400,23 +14418,14 @@ components:
             - amount
           description: The type of the discount.
           readOnly: true
-        rateCardDiscount:
-          allOf:
-            - $ref: '#/components/schemas/Discount'
-          description: The discount from the rate card this discount is based on.
-          readOnly: true
-        externalIds:
-          allOf:
-            - $ref: '#/components/schemas/InvoiceLineAppExternalIds'
-          description: External IDs of the invoice in other apps such as Stripe.
-          readOnly: true
       description: InvoiceLineDiscountAmount represents an amount deducted from the line, and will be applied before taxes.
     InvoiceLineDiscountUsage:
       type: object
       required:
         - createdAt
         - updatedAt
         - id
+        - reason
         - quantity
         - type
       properties:
@@ -14447,14 +14456,25 @@ components:
           description: ID of the charge or discount.
           example: 01G65Z755AFWAKHE12NY0CQ9FH
           readOnly: true
-        code:
-          type: string
+        reason:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceDiscountReason'
           description: Reason code.
           readOnly: true
         description:
           type: string
           description: Text description as to why the discount was applied.
           readOnly: true
+        externalIds:
+          allOf:
+            - $ref: '#/components/schemas/InvoiceLineAppExternalIds'
+          description: External IDs of the invoice in other apps such as Stripe.
+          readOnly: true
+        rateCardDiscount:
+          allOf:
+            - $ref: '#/components/schemas/Discount'
+          description: The discount from the rate card this discount is based on.
+          readOnly: true
         quantity:
           allOf:
             - $ref: '#/components/schemas/Numeric'
@@ -14476,11 +14496,6 @@ components:
             - usage
           description: The type of the discount.
           readOnly: true
-        rateCardDiscount:
-          allOf:
-            - $ref: '#/components/schemas/Discount'
-          description: The discount from the rate card this discount is based on.
-          readOnly: true
       description: |-
         InvoiceLineDiscountUsage represents an usage-based discount applied to the line.
 

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

@@ -4,6 +4,15 @@ import "@typespec/openapi3";
 
 namespace Invoices;
 
+/**
+ * Reason code.
+ */
+@friendlyName("InvoiceDiscountReason")
+enum InvoiceDiscountReason {
+  maximumSpend: "maximum_spend",
+  ratecardDiscount: "ratecard_discount",
+}
+
 /**
  * InvoiceDiscountBase represents a charge or discount that can be applied to a line or the entire invoice.
  */
@@ -21,13 +30,25 @@ model InvoiceDiscountBase {
    * Reason code.
    */
   @visibility(Lifecycle.Read)
-  code?: string;
+  reason: InvoiceDiscountReason;
 
   /**
    * Text description as to why the discount was applied.
    */
   @visibility(Lifecycle.Read)
   description?: string;
+
+  /**
+   * External IDs of the invoice in other apps such as Stripe.
+   */
+  @visibility(Lifecycle.Read)
+  externalIds?: InvoiceLineAppExternalIds;
+
+  /**
+   * The discount from the rate card this discount is based on.
+   */
+  @visibility(Lifecycle.Read)
+  rateCardDiscount?: OpenMeter.ProductCatalog.Discount;
 }
 
 /**
@@ -79,12 +100,6 @@ model InvoiceLineDiscountUsage {
    */
   @visibility(Lifecycle.Read)
   type: InvoiceLineDiscountType.usage;
-
-  /**
-   * The discount from the rate card this discount is based on.
-   */
-  @visibility(Lifecycle.Read)
-  rateCardDiscount?: OpenMeter.ProductCatalog.Discount;
 }
 
 /**
@@ -106,16 +121,4 @@ model InvoiceLineDiscountAmount {
    */
   @visibility(Lifecycle.Read)
   type: InvoiceLineDiscountType.amount;
-
-  /**
-   * The discount from the rate card this discount is based on.
-   */
-  @visibility(Lifecycle.Read)
-  rateCardDiscount?: OpenMeter.ProductCatalog.Discount;
-
-  /**
-   * External IDs of the invoice in other apps such as Stripe.
-   */
-  @visibility(Lifecycle.Read)
-  externalIds?: InvoiceLineAppExternalIds;
 }

openmeter/billing/adapter/invoicelinemapper.go

@@ -215,6 +215,7 @@ func (a *adapter) mapInvoiceLineWithoutReferences(dbLine *db.BillingInvoiceLine)
 				UpdatedAt: discount.UpdatedAt.In(time.UTC),
 				DeletedAt: convert.TimePtrIn(discount.DeletedAt, time.UTC),
 
+				Reason:                 discount.Reason,
 				Amount:                 discount.Amount,
 				Description:            discount.Description,
 				ChildUniqueReferenceID: discount.ChildUniqueReferenceID,

openmeter/billing/adapter/invoicelines.go

@@ -189,6 +189,7 @@ func (a *adapter) UpsertInvoiceLines(ctx context.Context, inputIn billing.Upsert
 					SetID(d.Discount.ID).
 					SetNamespace(d.Line.Namespace).
 					SetLineID(d.Line.ID).
+					SetReason(d.Discount.Reason).
 					SetNillableDeletedAt(d.Discount.DeletedAt).
 					SetAmount(d.Discount.Amount).
 					SetNillableChildUniqueReferenceID(d.Discount.ChildUniqueReferenceID).

openmeter/billing/httpdriver/invoiceline.go

@@ -448,9 +448,9 @@ func mapDiscountToAPI(discount billing.LineDiscount) (api.InvoiceLineDiscount, e
 		DeletedAt: discount.DeletedAt,
 		UpdatedAt: discount.UpdatedAt,
 
+		Reason:      api.InvoiceDiscountReason(discount.Reason),
 		Description: discount.Description,
 		Amount:      discount.Amount.String(),
-		Code:        discount.ChildUniqueReferenceID,
 		ExternalIds: &api.InvoiceLineAppExternalIds{
 			Invoicing: lo.EmptyableToPtr(discount.ExternalIDs.Invoicing),
 		},