orb-billing 5.15.0 → 5.17.0

package/src/resources/beta/external-plan-id.ts

@@ -153,6 +153,8 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
       | Shared.NewPlanScalableMatrixWithTieredPricingPrice
       | Shared.NewPlanCumulativeGroupedBulkPrice
       | Shared.NewPlanMinimumCompositePrice
+      | AddPrice.NewPlanPercentCompositePrice
+      | AddPrice.NewPlanEventOutputPrice
       | null;
   }
 
@@ -415,6 +417,238 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
         per_unit_rate: string;
       }
     }
+
+    export interface NewPlanPercentCompositePrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'percent';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for percent pricing
+       */
+      percent_config: NewPlanPercentCompositePrice.PercentConfig;
+
+      /**
+       * 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;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | 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;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewPlanPercentCompositePrice {
+      /**
+       * Configuration for percent pricing
+       */
+      export interface PercentConfig {
+        /**
+         * What percent of the component subtotals to charge
+         */
+        percent: number;
+      }
+    }
+
+    export interface NewPlanEventOutputPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for event_output pricing
+       */
+      event_output_config: NewPlanEventOutputPrice.EventOutputConfig;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'event_output';
+
+      /**
+       * 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;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | 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;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewPlanEventOutputPrice {
+      /**
+       * Configuration for event_output pricing
+       */
+      export interface EventOutputConfig {
+        /**
+         * The key in the event data to extract the unit rate from.
+         */
+        unit_rating_key: string;
+
+        /**
+         * An optional key in the event data to group by (e.g., event ID). All events will
+         * also be grouped by their unit rate.
+         */
+        grouping_key?: string | null;
+      }
+    }
   }
 
   export interface RemoveAdjustment {
@@ -510,6 +744,8 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
       | Shared.NewPlanScalableMatrixWithTieredPricingPrice
       | Shared.NewPlanCumulativeGroupedBulkPrice
       | Shared.NewPlanMinimumCompositePrice
+      | ReplacePrice.NewPlanPercentCompositePrice
+      | ReplacePrice.NewPlanEventOutputPrice
       | null;
   }
 
@@ -772,6 +1008,238 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
         per_unit_rate: string;
       }
     }
+
+    export interface NewPlanPercentCompositePrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'percent';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for percent pricing
+       */
+      percent_config: NewPlanPercentCompositePrice.PercentConfig;
+
+      /**
+       * 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;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | 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;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewPlanPercentCompositePrice {
+      /**
+       * Configuration for percent pricing
+       */
+      export interface PercentConfig {
+        /**
+         * What percent of the component subtotals to charge
+         */
+        percent: number;
+      }
+    }
+
+    export interface NewPlanEventOutputPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for event_output pricing
+       */
+      event_output_config: NewPlanEventOutputPrice.EventOutputConfig;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'event_output';
+
+      /**
+       * 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;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | 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;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewPlanEventOutputPrice {
+      /**
+       * Configuration for event_output pricing
+       */
+      export interface EventOutputConfig {
+        /**
+         * The key in the event data to extract the unit rate from.
+         */
+        unit_rating_key: string;
+
+        /**
+         * An optional key in the event data to group by (e.g., event ID). All events will
+         * also be grouped by their unit rate.
+         */
+        grouping_key?: string | null;
+      }
+    }
   }
 }
 

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

@@ -8,6 +8,17 @@ export class InvoiceLineItems extends APIResource {
   /**
    * This creates a one-off fixed fee invoice line item on an Invoice. This can only
    * be done for invoices that are in a `draft` status.
+   *
+   * The behavior depends on which parameters are provided:
+   *
+   * - If `item_id` is provided without `name`: The item is looked up by ID, and the
+   *   item's name is used for the line item.
+   * - If `name` is provided without `item_id`: An item with the given name is
+   *   searched for in the account. If found, that item is used. If not found, a new
+   *   item is created with that name. The new item's name is used for the line item.
+   * - If both `item_id` and `name` are provided: The item is looked up by ID for
+   *   association, but the provided `name` is used for the line item (not the item's
+   *   name).
    */
   create(
     body: InvoiceLineItemCreateParams,
@@ -168,12 +179,6 @@ export interface InvoiceLineItemCreateParams {
    */
   invoice_id: string;
 
-  /**
-   * The item name associated with this line item. If an item with the same name
-   * exists in Orb, that item will be associated with the line item.
-   */
-  name: string;
-
   /**
    * The number of units on the line item
    */
@@ -183,6 +188,24 @@ export interface InvoiceLineItemCreateParams {
    * A date string to specify the line item's start date in the customer's timezone.
    */
   start_date: string;
+
+  /**
+   * The id of the item to associate with this line item. If provided without `name`,
+   * the item's name will be used for the price/line item. If provided with `name`,
+   * the item will be associated but `name` will be used for the line item. At least
+   * one of `name` or `item_id` must be provided.
+   */
+  item_id?: string | null;
+
+  /**
+   * The name to use for the line item. If `item_id` is not provided, Orb will search
+   * for an item with this name. If found, that item will be associated with the line
+   * item. If not found, a new item will be created with this name. If `item_id` is
+   * provided, this name will be used for the line item, but the item association
+   * will be based on `item_id`. At least one of `name` or `item_id` must be
+   * provided.
+   */
+  name?: string | null;
 }
 
 export declare namespace InvoiceLineItems {

package/src/resources/items.ts

@@ -59,10 +59,20 @@ export class ItemsPage extends Page<Item> {}
  * external sync behavior for invoices and tax calculation purposes.
  */
 export interface Item {
+  /**
+   * The Orb-assigned unique identifier for the item.
+   */
   id: string;
 
+  /**
+   * The time at which the item was created.
+   */
   created_at: string;
 
+  /**
+   * A list of external connections for this item, used to sync with external
+   * invoicing and tax systems.
+   */
   external_connections: Array<Item.ExternalConnection>;
 
   /**
@@ -73,11 +83,26 @@ export interface Item {
    */
   metadata: { [key: string]: string };
 
+  /**
+   * The name of the item.
+   */
   name: string;
+
+  /**
+   * The time at which the item was archived. If null, the item is not archived.
+   */
+  archived_at?: string | null;
 }
 
 export namespace Item {
+  /**
+   * Represents a connection between an Item and an external system for invoicing or
+   * tax calculation purposes.
+   */
   export interface ExternalConnection {
+    /**
+     * The name of the external system this item is connected to.
+     */
     external_connection_name:
       | 'stripe'
       | 'quickbooks'
@@ -88,6 +113,9 @@ export namespace Item {
       | 'anrok'
       | 'numeral';
 
+    /**
+     * The identifier of this item in the external system.
+     */
     external_entity_id: string;
   }
 }
@@ -120,7 +148,14 @@ export interface ItemUpdateParams {
 }
 
 export namespace ItemUpdateParams {
+  /**
+   * Represents a connection between an Item and an external system for invoicing or
+   * tax calculation purposes.
+   */
   export interface ExternalConnection {
+    /**
+     * The name of the external system this item is connected to.
+     */
     external_connection_name:
       | 'stripe'
       | 'quickbooks'
@@ -131,6 +166,9 @@ export namespace ItemUpdateParams {
       | 'anrok'
       | 'numeral';
 
+    /**
+     * The identifier of this item in the external system.
+     */
     external_entity_id: string;
   }
 }