orb-billing 1.41.0 → 2.0.0

package/src/resources/credit-notes.ts

@@ -154,7 +154,7 @@ export namespace CreditNote {
     amount: string;
 
     /**
-     * Any line items discounts from the invoice's line item.
+     * Any line item discounts from the invoice's line item.
      */
     discounts: Array<LineItem.Discount>;
 
@@ -168,11 +168,6 @@ export namespace CreditNote {
      */
     quantity: number | null;
 
-    /**
-     * Any sub line items that may be credited.
-     */
-    sub_line_items: Array<LineItem.SubLineItem>;
-
     /**
      * The amount of the line item, excluding any line item minimums and discounts.
      */
@@ -201,14 +196,6 @@ export namespace CreditNote {
       reason?: string | null;
     }
 
-    export interface SubLineItem {
-      amount: string;
-
-      name: string;
-
-      quantity: number | null;
-    }
-
     export interface TaxAmount {
       /**
        * The amount of additional tax incurred by this tax rate.

package/src/resources/invoices.ts

@@ -42,6 +42,9 @@ export class Invoices extends APIResource {
   /**
    * This endpoint is used to fetch an [`Invoice`](../guides/concepts#invoice) given
    * an identifier.
+   *
+   * This endpoint supports returning ApiCachedUsageData (see
+   * api/cache_control_utils.py)
    */
   fetch(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
     return this._client.get(`/invoices/${invoiceId}`, options);
@@ -51,6 +54,9 @@ export class Invoices extends APIResource {
    * This endpoint can be used to fetch the upcoming
    * [invoice](../guides/concepts#invoice) for the current billing period given a
    * subscription.
+   *
+   * This endpoint supports returning ApiCachedUsageData (see
+   * api/cache_control_utils.py)
    */
   fetchUpcoming(
     query?: InvoiceFetchUpcomingParams,
@@ -416,6 +422,11 @@ export namespace Invoice {
 
     credit_note_number: string;
 
+    /**
+     * An optional memo supplied on the credit note.
+     */
+    memo: string | null;
+
     reason: string;
 
     total: string;
@@ -1496,6 +1507,11 @@ export namespace InvoiceFetchUpcomingResponse {
 
     credit_note_number: string;
 
+    /**
+     * An optional memo supplied on the credit note.
+     */
+    memo: string | null;
+
     reason: string;
 
     total: string;
@@ -2314,6 +2330,13 @@ export interface InvoiceCreateParams {
    */
   memo?: string | null;
 
+  /**
+   * User-specified key/value pairs for the resource. Individual keys can be removed
+   * by setting the value to `null`, and the entire metadata mapping can be cleared
+   * by setting `metadata` to `null`.
+   */
+  metadata?: Record<string, string | null> | null;
+
   /**
    * When true, this invoice will automatically be issued upon creation. When false,
    * the resulting invoice will require manual review to issue. Defaulted to false.
@@ -2396,7 +2419,7 @@ export interface InvoiceListParams extends PageParams {
 
   is_recurring?: boolean | null;
 
-  'status[]'?: Array<'draft' | 'issued' | 'paid' | 'synced' | 'void'> | null;
+  status?: Array<'draft' | 'issued' | 'paid' | 'synced' | 'void'> | null;
 
   subscription_id?: string | null;
 }

package/src/resources/plans/plans.ts

@@ -314,6 +314,7 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanThresholdTotalAmountPrice
     | PlanCreateParams.NewPlanTieredPackagePrice
     | PlanCreateParams.NewPlanTieredWithMinimumPrice
+    | PlanCreateParams.NewPlanUnitWithPercentPrice
     | PlanCreateParams.NewPlanPackageWithAllocationPrice
   >;
 
@@ -1082,6 +1083,55 @@ export namespace PlanCreateParams {
     invoice_grouping_key?: string | null;
   }
 
+  export interface NewPlanUnitWithPercentPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'unit_with_percent';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    unit_with_percent_config: Record<string, unknown>;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+  }
+
   export interface NewPlanPackageWithAllocationPrice {
     /**
      * The cadence to bill for this price on.

package/src/resources/prices/prices.ts

@@ -298,7 +298,9 @@ export type Price =
   | Price.ThresholdTotalAmountPrice
   | Price.TieredPackagePrice
   | Price.TieredWithMinimumPrice
-  | Price.PackageWithAllocationPrice;
+  | Price.PackageWithAllocationPrice
+  | Price.UnitWithPercentPrice
+  | Price.MatrixWithAllocationPrice;
 
 export namespace Price {
   export interface UnitPrice {
@@ -1399,12 +1401,214 @@ export namespace Price {
       minimum_amount: string;
     }
   }
+
+  export interface UnitWithPercentPrice {
+    id: string;
+
+    billable_metric: UnitWithPercentPrice.BillableMetric | null;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+
+    created_at: string;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    item: UnitWithPercentPrice.Item;
+
+    maximum: UnitWithPercentPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: UnitWithPercentPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'unit_with_percent';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+
+    unit_with_percent_config: Record<string, unknown>;
+  }
+
+  export namespace UnitWithPercentPrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface Item {
+      id: string;
+
+      name: string;
+    }
+
+    export interface Maximum {
+      /**
+       * List of price_ids that this maximum amount applies to. For plan/plan phase
+       * maximums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Maximum amount applied
+       */
+      maximum_amount: string;
+    }
+
+    export interface Minimum {
+      /**
+       * List of price_ids that this minimum amount applies to. For plan/plan phase
+       * minimums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Minimum amount applied
+       */
+      minimum_amount: string;
+    }
+  }
+
+  export interface MatrixWithAllocationPrice {
+    id: string;
+
+    billable_metric: MatrixWithAllocationPrice.BillableMetric | null;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'annual';
+
+    created_at: string;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    item: MatrixWithAllocationPrice.Item;
+
+    matrix_with_allocation_config: MatrixWithAllocationPrice.MatrixWithAllocationConfig;
+
+    maximum: MatrixWithAllocationPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    minimum: MatrixWithAllocationPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'matrix_with_allocation';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace MatrixWithAllocationPrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface Item {
+      id: string;
+
+      name: string;
+    }
+
+    export interface MatrixWithAllocationConfig {
+      /**
+       * Allocation to be used to calculate the price
+       */
+      allocation: number;
+
+      /**
+       * Default per unit rate for any usage not bucketed into a specified matrix_value
+       */
+      default_unit_amount: string;
+
+      /**
+       * One or two event property values to evaluate matrix groups by
+       */
+      dimensions: Array<string | null>;
+
+      /**
+       * Matrix values for specified matrix grouping keys
+       */
+      matrix_values: Array<MatrixWithAllocationConfig.MatrixValue>;
+
+      /**
+       * Default optional multiplier to scale rated quantities that fall into the default
+       * bucket by
+       */
+      scaling_factor?: number | null;
+    }
+
+    export namespace MatrixWithAllocationConfig {
+      export interface MatrixValue {
+        /**
+         * One or two matrix keys to filter usage to this Matrix value by. For example,
+         * ["region", "tier"] could be used to filter cloud usage by a cloud region and an
+         * instance tier.
+         */
+        dimension_values: Array<string | null>;
+
+        /**
+         * Unit price for the specified dimension_values
+         */
+        unit_amount: string;
+
+        /**
+         * Optional multiplier to scale rated quantities by
+         */
+        scaling_factor?: number | null;
+      }
+    }
+
+    export interface Maximum {
+      /**
+       * List of price_ids that this maximum amount applies to. For plan/plan phase
+       * maximums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Maximum amount applied
+       */
+      maximum_amount: string;
+    }
+
+    export interface Minimum {
+      /**
+       * List of price_ids that this minimum amount applies to. For plan/plan phase
+       * minimums, this can be a subset of prices.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Minimum amount applied
+       */
+      minimum_amount: string;
+    }
+  }
 }
 
 export type PriceCreateParams =
   | PriceCreateParams.NewFloatingUnitPrice
   | PriceCreateParams.NewFloatingPackagePrice
   | PriceCreateParams.NewFloatingMatrixPrice
+  | PriceCreateParams.NewFloatingMatrixWithAllocationPrice
   | PriceCreateParams.NewFloatingTieredPrice
   | PriceCreateParams.NewFloatingTieredBpsPrice
   | PriceCreateParams.NewFloatingBpsPrice
@@ -1413,7 +1617,9 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingThresholdTotalAmountPrice
   | PriceCreateParams.NewFloatingTieredPackagePrice
   | PriceCreateParams.NewFloatingTieredWithMinimumPrice
-  | PriceCreateParams.NewFloatingPackageWithAllocationPrice;
+  | PriceCreateParams.NewFloatingPackageWithAllocationPrice
+  | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice
+  | PriceCreateParams.NewFloatingUnitWithPercentPrice;
 
 export namespace PriceCreateParams {
   export interface NewFloatingUnitPrice {
@@ -1653,6 +1859,111 @@ export namespace PriceCreateParams {
     }
   }
 
+  export interface NewFloatingMatrixWithAllocationPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+
+    /**
+     * An ISO 4217 currency string for which this price is billed in.
+     */
+    currency: string;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    matrix_with_allocation_config: PriceCreateParams.NewFloatingMatrixWithAllocationPrice.MatrixWithAllocationConfig;
+
+    model_type: 'matrix_with_allocation';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+  }
+
+  export namespace NewFloatingMatrixWithAllocationPrice {
+    export interface MatrixWithAllocationConfig {
+      /**
+       * Allocation to be used to calculate the price
+       */
+      allocation: number;
+
+      /**
+       * Default per unit rate for any usage not bucketed into a specified matrix_value
+       */
+      default_unit_amount: string;
+
+      /**
+       * One or two event property values to evaluate matrix groups by
+       */
+      dimensions: Array<string | null>;
+
+      /**
+       * Matrix values for specified matrix grouping keys
+       */
+      matrix_values: Array<MatrixWithAllocationConfig.MatrixValue>;
+
+      /**
+       * Default optional multiplier to scale rated quantities that fall into the default
+       * bucket by
+       */
+      scaling_factor?: number | null;
+    }
+
+    export namespace MatrixWithAllocationConfig {
+      export interface MatrixValue {
+        /**
+         * One or two matrix keys to filter usage to this Matrix value by. For example,
+         * ["region", "tier"] could be used to filter cloud usage by a cloud region and an
+         * instance tier.
+         */
+        dimension_values: Array<string | null>;
+
+        /**
+         * Unit price for the specified dimension_values
+         */
+        unit_amount: string;
+
+        /**
+         * Optional multiplier to scale rated quantities by
+         */
+        scaling_factor?: number | null;
+      }
+    }
+  }
+
   export interface NewFloatingTieredPrice {
     /**
      * The cadence to bill for this price on.
@@ -2266,6 +2577,114 @@ export namespace PriceCreateParams {
      */
     invoice_grouping_key?: string | null;
   }
+
+  export interface NewFloatingTieredPackageWithMinimumPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+
+    /**
+     * An ISO 4217 currency string for which this price is billed in.
+     */
+    currency: string;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'tiered_package_with_minimum';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    tiered_package_with_minimum_config: Record<string, unknown>;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+  }
+
+  export interface NewFloatingUnitWithPercentPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'monthly' | 'quarterly' | 'one_time';
+
+    /**
+     * An ISO 4217 currency string for which this price is billed in.
+     */
+    currency: string;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'unit_with_percent';
+
+    /**
+     * The name of the price.
+     */
+    name: string;
+
+    unit_with_percent_config: Record<string, unknown>;
+
+    /**
+     * The id of the billable metric for the price. Only needed if the price is
+     * usage-based.
+     */
+    billable_metric_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, the price will be billed in-advance if
+     * this is true, and in-arrears if this is false.
+     */
+    billed_in_advance?: boolean | null;
+
+    /**
+     * An alias for the price.
+     */
+    external_price_id?: string | null;
+
+    /**
+     * If the Price represents a fixed cost, this represents the quantity of units
+     * applied.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The property used to group this price on an invoice
+     */
+    invoice_grouping_key?: string | null;
+  }
 }
 
 export interface PriceListParams extends PageParams {}