orb-billing 4.54.0 → 4.56.0

package/resources/invoice-line-items.d.ts

@@ -15,20 +15,21 @@ export interface InvoiceLineItemCreateResponse {
      */
     id: string;
     /**
-     * The line amount after any adjustments, before overage conversion, credits and
+     * The line amount after any adjustments and before overage conversion, credits and
      * partial invoicing.
      */
     adjusted_subtotal: string;
     /**
-     * All adjustments applied to the line item.
+     * All adjustments (ie. maximums, minimums, discounts) applied to the line item.
      */
-    adjustments: Array<InvoiceLineItemCreateResponse.AmountDiscountAdjustment | InvoiceLineItemCreateResponse.PercentageDiscountAdjustment | InvoiceLineItemCreateResponse.UsageDiscountAdjustment | InvoiceLineItemCreateResponse.MinimumAdjustment | InvoiceLineItemCreateResponse.MaximumAdjustment>;
+    adjustments: Array<InvoiceLineItemCreateResponse.MonetaryUsageDiscountAdjustment | InvoiceLineItemCreateResponse.MonetaryAmountDiscountAdjustment | InvoiceLineItemCreateResponse.MonetaryPercentageDiscountAdjustment | InvoiceLineItemCreateResponse.MonetaryMinimumAdjustment | InvoiceLineItemCreateResponse.MonetaryMaximumAdjustment>;
     /**
-     * The final amount after any discounts or minimums.
+     * The final amount for a line item after all adjustments and pre paid credits have
+     * been applied.
      */
     amount: string;
     /**
-     * The number of credits used
+     * The number of prepaid credits applied.
      */
     credits_applied: string;
     discount: Shared.Discount | null;
@@ -79,6 +80,9 @@ export interface InvoiceLineItemCreateResponse {
      * [the core concepts documentation](/core-concepts#plan-and-price)
      */
     price: PricesAPI.Price | null;
+    /**
+     * Either the fixed fee quantity or the usage during the service period.
+     */
     quantity: number;
     /**
      * The start date of the range of time applied for this line item's price.
@@ -90,7 +94,7 @@ export interface InvoiceLineItemCreateResponse {
      */
     sub_line_items: Array<InvoiceLineItemCreateResponse.MatrixSubLineItem | InvoiceLineItemCreateResponse.TierSubLineItem | InvoiceLineItemCreateResponse.OtherSubLineItem>;
     /**
-     * The line amount before any line item-specific discounts or minimums.
+     * The line amount before before any adjustments.
      */
     subtotal: string;
     /**
@@ -100,14 +104,13 @@ export interface InvoiceLineItemCreateResponse {
     tax_amounts: Array<InvoiceLineItemCreateResponse.TaxAmount>;
 }
 export declare namespace InvoiceLineItemCreateResponse {
-    interface AmountDiscountAdjustment {
+    interface MonetaryUsageDiscountAdjustment {
         id: string;
-        adjustment_type: 'amount_discount';
+        adjustment_type: 'usage_discount';
         /**
-         * The amount by which to discount the prices this adjustment applies to in a given
-         * billing period.
+         * The value applied by an adjustment.
          */
-        amount_discount: string;
+        amount: string;
         /**
          * The price IDs that this adjustment applies to.
          */
@@ -117,18 +120,28 @@ export declare namespace InvoiceLineItemCreateResponse {
          * that apply to only one price.
          */
         is_invoice_level: boolean;
-        /**
-         * The plan phase in which this adjustment is active.
-         */
-        plan_phase_order: number | null;
         /**
          * The reason for the adjustment.
          */
         reason: string | null;
+        /**
+         * The number of usage units by which to discount the price this adjustment applies
+         * to in a given billing period.
+         */
+        usage_discount: number;
     }
-    interface PercentageDiscountAdjustment {
+    interface MonetaryAmountDiscountAdjustment {
         id: string;
-        adjustment_type: 'percentage_discount';
+        adjustment_type: 'amount_discount';
+        /**
+         * The value applied by an adjustment.
+         */
+        amount: string;
+        /**
+         * The amount by which to discount the prices this adjustment applies to in a given
+         * billing period.
+         */
+        amount_discount: string;
         /**
          * The price IDs that this adjustment applies to.
          */
@@ -138,23 +151,18 @@ export declare namespace InvoiceLineItemCreateResponse {
          * that apply to only one price.
          */
         is_invoice_level: boolean;
-        /**
-         * The percentage (as a value between 0 and 1) by which to discount the price
-         * intervals this adjustment applies to in a given billing period.
-         */
-        percentage_discount: number;
-        /**
-         * The plan phase in which this adjustment is active.
-         */
-        plan_phase_order: number | null;
         /**
          * The reason for the adjustment.
          */
         reason: string | null;
     }
-    interface UsageDiscountAdjustment {
+    interface MonetaryPercentageDiscountAdjustment {
         id: string;
-        adjustment_type: 'usage_discount';
+        adjustment_type: 'percentage_discount';
+        /**
+         * The value applied by an adjustment.
+         */
+        amount: string;
         /**
          * The price IDs that this adjustment applies to.
          */
@@ -165,22 +173,22 @@ export declare namespace InvoiceLineItemCreateResponse {
          */
         is_invoice_level: boolean;
         /**
-         * The plan phase in which this adjustment is active.
+         * The percentage (as a value between 0 and 1) by which to discount the price
+         * intervals this adjustment applies to in a given billing period.
          */
-        plan_phase_order: number | null;
+        percentage_discount: number;
         /**
          * The reason for the adjustment.
          */
         reason: string | null;
-        /**
-         * The number of usage units by which to discount the price this adjustment applies
-         * to in a given billing period.
-         */
-        usage_discount: number;
     }
-    interface MinimumAdjustment {
+    interface MonetaryMinimumAdjustment {
         id: string;
         adjustment_type: 'minimum';
+        /**
+         * The value applied by an adjustment.
+         */
+        amount: string;
         /**
          * The price IDs that this adjustment applies to.
          */
@@ -199,18 +207,18 @@ export declare namespace InvoiceLineItemCreateResponse {
          * adjustment applies to.
          */
         minimum_amount: string;
-        /**
-         * The plan phase in which this adjustment is active.
-         */
-        plan_phase_order: number | null;
         /**
          * The reason for the adjustment.
          */
         reason: string | null;
     }
-    interface MaximumAdjustment {
+    interface MonetaryMaximumAdjustment {
         id: string;
         adjustment_type: 'maximum';
+        /**
+         * The value applied by an adjustment.
+         */
+        amount: string;
         /**
          * The price IDs that this adjustment applies to.
          */
@@ -225,10 +233,6 @@ export declare namespace InvoiceLineItemCreateResponse {
          * adjustment applies to.
          */
         maximum_amount: string;
-        /**
-         * The plan phase in which this adjustment is active.
-         */
-        plan_phase_order: number | null;
         /**
          * The reason for the adjustment.
          */

package/resources/invoice-line-items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoice-line-items.d.ts","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAE7C,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,KAAK,CACd,6BAA6B,CAAC,wBAAwB,GACtD,6BAA6B,CAAC,4BAA4B,GAC1D,6BAA6B,CAAC,uBAAuB,GACrD,6BAA6B,CAAC,iBAAiB,GAC/C,6BAA6B,CAAC,iBAAiB,CAClD,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,6BAA6B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,6BAA6B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC;IAE9B,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,KAAK,CACjB,6BAA6B,CAAC,iBAAiB,GAC/C,6BAA6B,CAAC,eAAe,GAC7C,6BAA6B,CAAC,gBAAgB,CACjD,CAAC;IAEF;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;CAC7D;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,wBAAwB;QACvC,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,iBAAiB,CAAC;QAEnC;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,4BAA4B;QAC3C,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,qBAAqB,CAAC;QAEvC;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,uBAAuB;QACtC,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,gBAAgB,CAAC;QAElC;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,iBAAiB;QAChC,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,SAAS,CAAC;QAE3B;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,iBAAiB;QAChC,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,SAAS,CAAC;QAE3B;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE5C,aAAa,EAAE,iBAAiB,CAAC,YAAY,CAAC;QAE9C,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,QAAQ;YACvB,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;SACxC;KACF;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,eAAe,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE1C,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC;QAExC,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,QAAQ;YACvB,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,UAAU;YACzB,UAAU,EAAE,MAAM,CAAC;YAEnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;IAED,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE3C,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,QAAQ;YACvB,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
+{"version":3,"file":"invoice-line-items.d.ts","sourceRoot":"","sources":["../src/resources/invoice-line-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAE7C,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,KAAK,CACd,6BAA6B,CAAC,+BAA+B,GAC7D,6BAA6B,CAAC,gCAAgC,GAC9D,6BAA6B,CAAC,oCAAoC,GAClE,6BAA6B,CAAC,yBAAyB,GACvD,6BAA6B,CAAC,yBAAyB,CAC1D,CAAC;IAEF;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,6BAA6B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,OAAO,EAAE,6BAA6B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,EAAE,KAAK,CACjB,6BAA6B,CAAC,iBAAiB,GAC/C,6BAA6B,CAAC,eAAe,GAC7C,6BAA6B,CAAC,gBAAgB,CACjD,CAAC;IAEF;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,WAAW,EAAE,KAAK,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;CAC7D;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,+BAA+B;QAC9C,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,gBAAgB,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,gCAAgC;QAC/C,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,iBAAiB,CAAC;QAEnC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,oCAAoC;QACnD,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,qBAAqB,CAAC;QAEvC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,yBAAyB;QACxC,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,SAAS,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,yBAAyB;QACxC,EAAE,EAAE,MAAM,CAAC;QAEX,eAAe,EAAE,SAAS,CAAC;QAE3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE5C,aAAa,EAAE,iBAAiB,CAAC,YAAY,CAAC;QAE9C,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,QAAQ;YACvB,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;SACxC;KACF;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,eAAe,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE1C,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC;QAExC,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,eAAe,CAAC;QAC/B,UAAiB,QAAQ;YACvB,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,UAAU;YACzB,UAAU,EAAE,MAAM,CAAC;YAEnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;IAED,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE3C,IAAI,EAAE,MAAM,CAAC;QAEb,QAAQ,EAAE,MAAM,CAAC;QAEjB,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,QAAQ;YACvB,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;WAEG;QACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/invoices.d.ts

@@ -394,7 +394,7 @@ export declare namespace Invoice {
          * A unique id for this transaction.
          */
         id: string;
-        action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund';
+        action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment';
         /**
          * The value of the amount changed in the transaction.
          */
@@ -553,20 +553,21 @@ export declare namespace Invoice {
          */
         id: string;
         /**
-         * The line amount after any adjustments, before overage conversion, credits and
+         * The line amount after any adjustments and before overage conversion, credits and
          * partial invoicing.
          */
         adjusted_subtotal: string;
         /**
-         * All adjustments applied to the line item.
+         * All adjustments (ie. maximums, minimums, discounts) applied to the line item.
          */
-        adjustments: Array<LineItem.AmountDiscountAdjustment | LineItem.PercentageDiscountAdjustment | LineItem.UsageDiscountAdjustment | LineItem.MinimumAdjustment | LineItem.MaximumAdjustment>;
+        adjustments: Array<LineItem.MonetaryUsageDiscountAdjustment | LineItem.MonetaryAmountDiscountAdjustment | LineItem.MonetaryPercentageDiscountAdjustment | LineItem.MonetaryMinimumAdjustment | LineItem.MonetaryMaximumAdjustment>;
         /**
-         * The final amount after any discounts or minimums.
+         * The final amount for a line item after all adjustments and pre paid credits have
+         * been applied.
          */
         amount: string;
         /**
-         * The number of credits used
+         * The number of prepaid credits applied.
          */
         credits_applied: string;
         discount: Shared.Discount | null;
@@ -617,6 +618,9 @@ export declare namespace Invoice {
          * [the core concepts documentation](/core-concepts#plan-and-price)
          */
         price: PricesAPI.Price | null;
+        /**
+         * Either the fixed fee quantity or the usage during the service period.
+         */
         quantity: number;
         /**
          * The start date of the range of time applied for this line item's price.
@@ -628,7 +632,7 @@ export declare namespace Invoice {
          */
         sub_line_items: Array<LineItem.MatrixSubLineItem | LineItem.TierSubLineItem | LineItem.OtherSubLineItem>;
         /**
-         * The line amount before any line item-specific discounts or minimums.
+         * The line amount before before any adjustments.
          */
         subtotal: string;
         /**
@@ -638,14 +642,13 @@ export declare namespace Invoice {
         tax_amounts: Array<LineItem.TaxAmount>;
     }
     namespace LineItem {
-        interface AmountDiscountAdjustment {
+        interface MonetaryUsageDiscountAdjustment {
             id: string;
-            adjustment_type: 'amount_discount';
+            adjustment_type: 'usage_discount';
             /**
-             * The amount by which to discount the prices this adjustment applies to in a given
-             * billing period.
+             * The value applied by an adjustment.
              */
-            amount_discount: string;
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -655,18 +658,28 @@ export declare namespace Invoice {
              * that apply to only one price.
              */
             is_invoice_level: boolean;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
+            /**
+             * The number of usage units by which to discount the price this adjustment applies
+             * to in a given billing period.
+             */
+            usage_discount: number;
         }
-        interface PercentageDiscountAdjustment {
+        interface MonetaryAmountDiscountAdjustment {
             id: string;
-            adjustment_type: 'percentage_discount';
+            adjustment_type: 'amount_discount';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
+            /**
+             * The amount by which to discount the prices this adjustment applies to in a given
+             * billing period.
+             */
+            amount_discount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -676,23 +689,18 @@ export declare namespace Invoice {
              * that apply to only one price.
              */
             is_invoice_level: boolean;
-            /**
-             * The percentage (as a value between 0 and 1) by which to discount the price
-             * intervals this adjustment applies to in a given billing period.
-             */
-            percentage_discount: number;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
         }
-        interface UsageDiscountAdjustment {
+        interface MonetaryPercentageDiscountAdjustment {
             id: string;
-            adjustment_type: 'usage_discount';
+            adjustment_type: 'percentage_discount';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -703,22 +711,22 @@ export declare namespace Invoice {
              */
             is_invoice_level: boolean;
             /**
-             * The plan phase in which this adjustment is active.
+             * The percentage (as a value between 0 and 1) by which to discount the price
+             * intervals this adjustment applies to in a given billing period.
              */
-            plan_phase_order: number | null;
+            percentage_discount: number;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
-            /**
-             * The number of usage units by which to discount the price this adjustment applies
-             * to in a given billing period.
-             */
-            usage_discount: number;
         }
-        interface MinimumAdjustment {
+        interface MonetaryMinimumAdjustment {
             id: string;
             adjustment_type: 'minimum';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -737,18 +745,18 @@ export declare namespace Invoice {
              * adjustment applies to.
              */
             minimum_amount: string;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
         }
-        interface MaximumAdjustment {
+        interface MonetaryMaximumAdjustment {
             id: string;
             adjustment_type: 'maximum';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -763,10 +771,6 @@ export declare namespace Invoice {
              * adjustment applies to.
              */
             maximum_amount: string;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
@@ -1255,7 +1259,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * A unique id for this transaction.
          */
         id: string;
-        action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund';
+        action: 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment';
         /**
          * The value of the amount changed in the transaction.
          */
@@ -1414,20 +1418,21 @@ export declare namespace InvoiceFetchUpcomingResponse {
          */
         id: string;
         /**
-         * The line amount after any adjustments, before overage conversion, credits and
+         * The line amount after any adjustments and before overage conversion, credits and
          * partial invoicing.
          */
         adjusted_subtotal: string;
         /**
-         * All adjustments applied to the line item.
+         * All adjustments (ie. maximums, minimums, discounts) applied to the line item.
          */
-        adjustments: Array<LineItem.AmountDiscountAdjustment | LineItem.PercentageDiscountAdjustment | LineItem.UsageDiscountAdjustment | LineItem.MinimumAdjustment | LineItem.MaximumAdjustment>;
+        adjustments: Array<LineItem.MonetaryUsageDiscountAdjustment | LineItem.MonetaryAmountDiscountAdjustment | LineItem.MonetaryPercentageDiscountAdjustment | LineItem.MonetaryMinimumAdjustment | LineItem.MonetaryMaximumAdjustment>;
         /**
-         * The final amount after any discounts or minimums.
+         * The final amount for a line item after all adjustments and pre paid credits have
+         * been applied.
          */
         amount: string;
         /**
-         * The number of credits used
+         * The number of prepaid credits applied.
          */
         credits_applied: string;
         discount: Shared.Discount | null;
@@ -1478,6 +1483,9 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * [the core concepts documentation](/core-concepts#plan-and-price)
          */
         price: PricesAPI.Price | null;
+        /**
+         * Either the fixed fee quantity or the usage during the service period.
+         */
         quantity: number;
         /**
          * The start date of the range of time applied for this line item's price.
@@ -1489,7 +1497,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          */
         sub_line_items: Array<LineItem.MatrixSubLineItem | LineItem.TierSubLineItem | LineItem.OtherSubLineItem>;
         /**
-         * The line amount before any line item-specific discounts or minimums.
+         * The line amount before before any adjustments.
          */
         subtotal: string;
         /**
@@ -1499,14 +1507,13 @@ export declare namespace InvoiceFetchUpcomingResponse {
         tax_amounts: Array<LineItem.TaxAmount>;
     }
     namespace LineItem {
-        interface AmountDiscountAdjustment {
+        interface MonetaryUsageDiscountAdjustment {
             id: string;
-            adjustment_type: 'amount_discount';
+            adjustment_type: 'usage_discount';
             /**
-             * The amount by which to discount the prices this adjustment applies to in a given
-             * billing period.
+             * The value applied by an adjustment.
              */
-            amount_discount: string;
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -1516,18 +1523,28 @@ export declare namespace InvoiceFetchUpcomingResponse {
              * that apply to only one price.
              */
             is_invoice_level: boolean;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
+            /**
+             * The number of usage units by which to discount the price this adjustment applies
+             * to in a given billing period.
+             */
+            usage_discount: number;
         }
-        interface PercentageDiscountAdjustment {
+        interface MonetaryAmountDiscountAdjustment {
             id: string;
-            adjustment_type: 'percentage_discount';
+            adjustment_type: 'amount_discount';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
+            /**
+             * The amount by which to discount the prices this adjustment applies to in a given
+             * billing period.
+             */
+            amount_discount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -1537,23 +1554,18 @@ export declare namespace InvoiceFetchUpcomingResponse {
              * that apply to only one price.
              */
             is_invoice_level: boolean;
-            /**
-             * The percentage (as a value between 0 and 1) by which to discount the price
-             * intervals this adjustment applies to in a given billing period.
-             */
-            percentage_discount: number;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
         }
-        interface UsageDiscountAdjustment {
+        interface MonetaryPercentageDiscountAdjustment {
             id: string;
-            adjustment_type: 'usage_discount';
+            adjustment_type: 'percentage_discount';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -1564,22 +1576,22 @@ export declare namespace InvoiceFetchUpcomingResponse {
              */
             is_invoice_level: boolean;
             /**
-             * The plan phase in which this adjustment is active.
+             * The percentage (as a value between 0 and 1) by which to discount the price
+             * intervals this adjustment applies to in a given billing period.
              */
-            plan_phase_order: number | null;
+            percentage_discount: number;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
-            /**
-             * The number of usage units by which to discount the price this adjustment applies
-             * to in a given billing period.
-             */
-            usage_discount: number;
         }
-        interface MinimumAdjustment {
+        interface MonetaryMinimumAdjustment {
             id: string;
             adjustment_type: 'minimum';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -1598,18 +1610,18 @@ export declare namespace InvoiceFetchUpcomingResponse {
              * adjustment applies to.
              */
             minimum_amount: string;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */
             reason: string | null;
         }
-        interface MaximumAdjustment {
+        interface MonetaryMaximumAdjustment {
             id: string;
             adjustment_type: 'maximum';
+            /**
+             * The value applied by an adjustment.
+             */
+            amount: string;
             /**
              * The price IDs that this adjustment applies to.
              */
@@ -1624,10 +1636,6 @@ export declare namespace InvoiceFetchUpcomingResponse {
              * adjustment applies to.
              */
             maximum_amount: string;
-            /**
-             * The plan phase in which this adjustment is active.
-             */
-            plan_phase_order: number | null;
             /**
              * The reason for the adjustment.
              */