orb-billing 4.54.0 → 4.56.0

package/src/resources/invoices.ts

@@ -524,7 +524,8 @@ export namespace Invoice {
       | 'return_from_voiding'
       | 'credit_note_applied'
       | 'credit_note_voided'
-      | 'overpayment_refund';
+      | 'overpayment_refund'
+      | 'external_payment';
 
     /**
      * The value of the amount changed in the transaction.
@@ -847,29 +848,30 @@ export 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
+      | 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;
 
@@ -931,6 +933,9 @@ export namespace Invoice {
      */
     price: PricesAPI.Price | null;
 
+    /**
+     * Either the fixed fee quantity or the usage during the service period.
+     */
     quantity: number;
 
     /**
@@ -945,7 +950,7 @@ export 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;
 
@@ -957,16 +962,15 @@ export namespace Invoice {
   }
 
   export namespace LineItem {
-    export interface AmountDiscountAdjustment {
+    export 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.
@@ -980,42 +984,43 @@ export namespace Invoice {
       is_invoice_level: boolean;
 
       /**
-       * The plan phase in which this adjustment is active.
+       * The reason for the adjustment.
        */
-      plan_phase_order: number | null;
+      reason: string | null;
 
       /**
-       * The reason for the adjustment.
+       * The number of usage units by which to discount the price this adjustment applies
+       * to in a given billing period.
        */
-      reason: string | null;
+      usage_discount: number;
     }
 
-    export interface PercentageDiscountAdjustment {
+    export interface MonetaryAmountDiscountAdjustment {
       id: string;
 
-      adjustment_type: 'percentage_discount';
+      adjustment_type: 'amount_discount';
 
       /**
-       * The price IDs that this adjustment applies to.
+       * The value applied by an adjustment.
        */
-      applies_to_price_ids: Array<string>;
+      amount: string;
 
       /**
-       * True for adjustments that apply to an entire invocice, false for adjustments
-       * that apply to only one price.
+       * The amount by which to discount the prices this adjustment applies to in a given
+       * billing period.
        */
-      is_invoice_level: boolean;
+      amount_discount: string;
 
       /**
-       * 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.
+       * The price IDs that this adjustment applies to.
        */
-      percentage_discount: number;
+      applies_to_price_ids: Array<string>;
 
       /**
-       * The plan phase in which this adjustment is active.
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
        */
-      plan_phase_order: number | null;
+      is_invoice_level: boolean;
 
       /**
        * The reason for the adjustment.
@@ -1023,10 +1028,15 @@ export namespace Invoice {
       reason: string | null;
     }
 
-    export interface UsageDiscountAdjustment {
+    export 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.
@@ -1040,27 +1050,27 @@ export 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;
     }
 
-    export interface MinimumAdjustment {
+    export interface MonetaryMinimumAdjustment {
       id: string;
 
       adjustment_type: 'minimum';
 
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
       /**
        * The price IDs that this adjustment applies to.
        */
@@ -1083,22 +1093,22 @@ export namespace Invoice {
        */
       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;
     }
 
-    export interface MaximumAdjustment {
+    export interface MonetaryMaximumAdjustment {
       id: string;
 
       adjustment_type: 'maximum';
 
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
       /**
        * The price IDs that this adjustment applies to.
        */
@@ -1116,11 +1126,6 @@ export namespace Invoice {
        */
       maximum_amount: string;
 
-      /**
-       * The plan phase in which this adjustment is active.
-       */
-      plan_phase_order: number | null;
-
       /**
        * The reason for the adjustment.
        */
@@ -1730,7 +1735,8 @@ export namespace InvoiceFetchUpcomingResponse {
       | 'return_from_voiding'
       | 'credit_note_applied'
       | 'credit_note_voided'
-      | 'overpayment_refund';
+      | 'overpayment_refund'
+      | 'external_payment';
 
     /**
      * The value of the amount changed in the transaction.
@@ -2053,29 +2059,30 @@ export 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
+      | 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;
 
@@ -2137,6 +2144,9 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     price: PricesAPI.Price | null;
 
+    /**
+     * Either the fixed fee quantity or the usage during the service period.
+     */
     quantity: number;
 
     /**
@@ -2151,7 +2161,7 @@ export 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;
 
@@ -2163,16 +2173,15 @@ export namespace InvoiceFetchUpcomingResponse {
   }
 
   export namespace LineItem {
-    export interface AmountDiscountAdjustment {
+    export 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.
@@ -2186,42 +2195,43 @@ export namespace InvoiceFetchUpcomingResponse {
       is_invoice_level: boolean;
 
       /**
-       * The plan phase in which this adjustment is active.
+       * The reason for the adjustment.
        */
-      plan_phase_order: number | null;
+      reason: string | null;
 
       /**
-       * The reason for the adjustment.
+       * The number of usage units by which to discount the price this adjustment applies
+       * to in a given billing period.
        */
-      reason: string | null;
+      usage_discount: number;
     }
 
-    export interface PercentageDiscountAdjustment {
+    export interface MonetaryAmountDiscountAdjustment {
       id: string;
 
-      adjustment_type: 'percentage_discount';
+      adjustment_type: 'amount_discount';
 
       /**
-       * The price IDs that this adjustment applies to.
+       * The value applied by an adjustment.
        */
-      applies_to_price_ids: Array<string>;
+      amount: string;
 
       /**
-       * True for adjustments that apply to an entire invocice, false for adjustments
-       * that apply to only one price.
+       * The amount by which to discount the prices this adjustment applies to in a given
+       * billing period.
        */
-      is_invoice_level: boolean;
+      amount_discount: string;
 
       /**
-       * 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.
+       * The price IDs that this adjustment applies to.
        */
-      percentage_discount: number;
+      applies_to_price_ids: Array<string>;
 
       /**
-       * The plan phase in which this adjustment is active.
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
        */
-      plan_phase_order: number | null;
+      is_invoice_level: boolean;
 
       /**
        * The reason for the adjustment.
@@ -2229,10 +2239,15 @@ export namespace InvoiceFetchUpcomingResponse {
       reason: string | null;
     }
 
-    export interface UsageDiscountAdjustment {
+    export 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.
@@ -2246,27 +2261,27 @@ export 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;
     }
 
-    export interface MinimumAdjustment {
+    export interface MonetaryMinimumAdjustment {
       id: string;
 
       adjustment_type: 'minimum';
 
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
       /**
        * The price IDs that this adjustment applies to.
        */
@@ -2289,22 +2304,22 @@ export namespace InvoiceFetchUpcomingResponse {
        */
       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;
     }
 
-    export interface MaximumAdjustment {
+    export interface MonetaryMaximumAdjustment {
       id: string;
 
       adjustment_type: 'maximum';
 
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
       /**
        * The price IDs that this adjustment applies to.
        */
@@ -2322,11 +2337,6 @@ export namespace InvoiceFetchUpcomingResponse {
        */
       maximum_amount: string;
 
-      /**
-       * The plan phase in which this adjustment is active.
-       */
-      plan_phase_order: number | null;
-
       /**
        * The reason for the adjustment.
        */

package/src/resources/plans/plans.ts

@@ -88,11 +88,11 @@ export interface Plan {
    * across all phases of the plan.
    */
   adjustments: Array<
-    | Plan.AmountDiscountAdjustment
-    | Plan.PercentageDiscountAdjustment
-    | Plan.UsageDiscountAdjustment
-    | Plan.MinimumAdjustment
-    | Plan.MaximumAdjustment
+    | Plan.PlanPhaseUsageDiscountAdjustment
+    | Plan.PlanPhaseAmountDiscountAdjustment
+    | Plan.PlanPhasePercentageDiscountAdjustment
+    | Plan.PlanPhaseMinimumAdjustment
+    | Plan.PlanPhaseMaximumAdjustment
   >;
 
   base_plan: Plan.BasePlan | null;
@@ -179,16 +179,10 @@ export interface Plan {
 }
 
 export namespace Plan {
-  export interface AmountDiscountAdjustment {
+  export interface PlanPhaseUsageDiscountAdjustment {
     id: string;
 
-    adjustment_type: 'amount_discount';
-
-    /**
-     * The amount by which to discount the prices this adjustment applies to in a given
-     * billing period.
-     */
-    amount_discount: string;
+    adjustment_type: 'usage_discount';
 
     /**
      * The price IDs that this adjustment applies to.
@@ -210,12 +204,24 @@ export namespace Plan {
      * 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;
   }
 
-  export interface PercentageDiscountAdjustment {
+  export interface PlanPhaseAmountDiscountAdjustment {
     id: string;
 
-    adjustment_type: 'percentage_discount';
+    adjustment_type: 'amount_discount';
+
+    /**
+     * 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.
@@ -228,12 +234,6 @@ export namespace Plan {
      */
     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.
      */
@@ -245,10 +245,10 @@ export namespace Plan {
     reason: string | null;
   }
 
-  export interface UsageDiscountAdjustment {
+  export interface PlanPhasePercentageDiscountAdjustment {
     id: string;
 
-    adjustment_type: 'usage_discount';
+    adjustment_type: 'percentage_discount';
 
     /**
      * The price IDs that this adjustment applies to.
@@ -261,6 +261,12 @@ export namespace Plan {
      */
     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.
      */
@@ -270,15 +276,9 @@ export namespace Plan {
      * 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;
   }
 
-  export interface MinimumAdjustment {
+  export interface PlanPhaseMinimumAdjustment {
     id: string;
 
     adjustment_type: 'minimum';
@@ -316,7 +316,7 @@ export namespace Plan {
     reason: string | null;
   }
 
-  export interface MaximumAdjustment {
+  export interface PlanPhaseMaximumAdjustment {
     id: string;
 
     adjustment_type: 'maximum';