orb-billing 4.72.3 → 4.74.0

package/src/resources/beta/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Beta,
+  type PlanVersion,
+  type PlanVersionPhase,
+  type BetaCreatePlanVersionParams,
+  type BetaSetDefaultPlanVersionParams,
+} from './beta';
+export {
+  ExternalPlanID,
+  type ExternalPlanIDCreatePlanVersionParams,
+  type ExternalPlanIDSetDefaultPlanVersionParams,
+} from './external-plan-id';

package/src/resources/beta.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './beta/index';

package/src/resources/credit-notes.ts

@@ -254,14 +254,14 @@ export interface CreditNoteCreateParams {
   line_items: Array<CreditNoteCreateParams.LineItem>;
 
   /**
-   * An optional memo to attach to the credit note.
+   * An optional reason for the credit note.
    */
-  memo?: string | null;
+  reason: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory';
 
   /**
-   * An optional reason for the credit note.
+   * An optional memo to attach to the credit note.
    */
-  reason?: 'duplicate' | 'fraudulent' | 'order_change' | 'product_unsatisfactory' | null;
+  memo?: string | null;
 }
 
 export namespace CreditNoteCreateParams {

package/src/resources/customers/balance-transactions.ts

@@ -40,13 +40,6 @@ export class BalanceTransactions extends APIResource {
    * This endpoint retrieves all customer balance transactions in reverse
    * chronological order for a single customer, providing a complete audit trail of
    * all adjustments and invoice applications.
-   *
-   * ## Eligibility
-   *
-   * The customer balance can only be applied to invoices or adjusted manually if
-   * invoices are not synced to a separate invoicing provider. If a payment gateway
-   * such as Stripe is used, the balance will be applied to the invoice before
-   * forwarding payment to the gateway.
    */
   list(
     customerId: string,

package/src/resources/customers/credits/ledger.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
+import * as InvoicesAPI from '../../invoices';
 import { Page, type PageParams } from '../../../pagination';
 
 export class Ledger extends APIResource {
@@ -513,6 +514,11 @@ export namespace LedgerListResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {
@@ -896,6 +902,11 @@ export namespace LedgerCreateEntryResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {
@@ -1279,6 +1290,11 @@ export namespace LedgerCreateEntryByExternalIDResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {
@@ -1662,6 +1678,11 @@ export namespace LedgerListByExternalIDResponse {
     metadata: Record<string, string>;
 
     starting_balance: number;
+
+    /**
+     * If the increment resulted in invoice creation, the list of created invoices
+     */
+    created_invoices?: Array<InvoicesAPI.Invoice> | null;
   }
 
   export namespace IncrementLedgerEntry {

package/src/resources/customers/credits/top-ups.ts

@@ -193,8 +193,10 @@ export namespace TopUpCreateResponse {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -266,8 +268,10 @@ export namespace TopUpListResponse {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -339,8 +343,10 @@ export namespace TopUpCreateByExternalIDResponse {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -412,8 +418,10 @@ export namespace TopUpListByExternalIDResponse {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -449,7 +457,7 @@ export interface TopUpCreateParams {
 
   /**
    * The date from which the top-up is active. If unspecified, the top-up is active
-   * immediately.
+   * immediately. This should not be more than 10 days in the past.
    */
   active_from?: string | null;
 
@@ -489,8 +497,10 @@ export namespace TopUpCreateParams {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -528,7 +538,7 @@ export interface TopUpCreateByExternalIDParams {
 
   /**
    * The date from which the top-up is active. If unspecified, the top-up is active
-   * immediately.
+   * immediately. This should not be more than 10 days in the past.
    */
   active_from?: string | null;
 
@@ -568,8 +578,10 @@ export namespace TopUpCreateByExternalIDParams {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }

package/src/resources/customers/customers.ts

@@ -103,10 +103,7 @@ export class Customers extends APIResource {
    * **Note**: This operation happens asynchronously and can be expected to take a
    * few minutes to propagate to related resources. However, querying for the
    * customer on subsequent GET requests while deletion is in process will reflect
-   * its deletion with a `deleted: true` property. Once the customer deletion has
-   * been fully processed, the customer will not be returned in the API.
-   *
-   * On successful processing, this returns an empty dictionary (`{}`) in the API.
+   * its deletion.
    */
   delete(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/customers/${customerId}`, {
@@ -812,6 +809,7 @@ export interface CustomerCreateParams {
   tax_configuration?:
     | CustomerCreateParams.NewAvalaraTaxConfiguration
     | CustomerCreateParams.NewTaxJarConfiguration
+    | CustomerCreateParams.NewSphereConfiguration
     | null;
 
   /**
@@ -1009,6 +1007,12 @@ export namespace CustomerCreateParams {
     tax_provider: 'taxjar';
   }
 
+  export interface NewSphereConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'sphere';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1352,6 +1356,7 @@ export interface CustomerUpdateParams {
   tax_configuration?:
     | CustomerUpdateParams.NewAvalaraTaxConfiguration
     | CustomerUpdateParams.NewTaxJarConfiguration
+    | CustomerUpdateParams.NewSphereConfiguration
     | null;
 
   /**
@@ -1542,6 +1547,12 @@ export namespace CustomerUpdateParams {
     tax_provider: 'taxjar';
   }
 
+  export interface NewSphereConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'sphere';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1895,6 +1906,7 @@ export interface CustomerUpdateByExternalIDParams {
   tax_configuration?:
     | CustomerUpdateByExternalIDParams.NewAvalaraTaxConfiguration
     | CustomerUpdateByExternalIDParams.NewTaxJarConfiguration
+    | CustomerUpdateByExternalIDParams.NewSphereConfiguration
     | null;
 
   /**
@@ -2085,6 +2097,12 @@ export namespace CustomerUpdateByExternalIDParams {
     tax_provider: 'taxjar';
   }
 
+  export interface NewSphereConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'sphere';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.

package/src/resources/dimensional-price-groups/dimensional-price-groups.ts

@@ -20,7 +20,7 @@ export class DimensionalPriceGroups extends APIResource {
    * For example, suppose we have a billable metric that measures the number of
    * widgets used and we want to charge differently depending on the color of the
    * widget. We can create a price group with a dimension "color" and two prices: one
-   * that charges $10 per red widget and one that charges $20 per blue widget.
+   * that charges \$10 per red widget and one that charges \$20 per blue widget.
    */
   create(
     body: DimensionalPriceGroupCreateParams,

package/src/resources/events/events.ts

@@ -451,7 +451,7 @@ export namespace EventSearchResponse {
      * A dictionary of custom properties. Values in this dictionary must be numeric,
      * boolean, or strings. Nested dictionaries are disallowed.
      */
-    properties: unknown;
+    properties: Record<string, unknown>;
 
     /**
      * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -472,7 +472,7 @@ export interface EventUpdateParams {
    * A dictionary of custom properties. Values in this dictionary must be numeric,
    * boolean, or strings. Nested dictionaries are disallowed.
    */
-  properties: unknown;
+  properties: Record<string, unknown>;
 
   /**
    * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -530,7 +530,7 @@ export namespace EventIngestParams {
      * A dictionary of custom properties. Values in this dictionary must be numeric,
      * boolean, or strings. Nested dictionaries are disallowed.
      */
-    properties: unknown;
+    properties: Record<string, unknown>;
 
     /**
      * An ISO 8601 format date with no timezone offset (i.e. UTC). This should

package/src/resources/index.ts

@@ -13,6 +13,13 @@ export {
   type AlertDisableParams,
   type AlertEnableParams,
 } from './alerts';
+export {
+  Beta,
+  type PlanVersion,
+  type PlanVersionPhase,
+  type BetaCreatePlanVersionParams,
+  type BetaSetDefaultPlanVersionParams,
+} from './beta/beta';
 export {
   BillableMetricsPage,
   Metrics,
@@ -100,10 +107,12 @@ export {
   type EvaluatePriceGroup,
   type Price,
   type PriceEvaluateResponse,
+  type PriceEvaluateMultipleResponse,
   type PriceCreateParams,
   type PriceUpdateParams,
   type PriceListParams,
   type PriceEvaluateParams,
+  type PriceEvaluateMultipleParams,
 } from './prices/prices';
 export {
   SubscriptionChanges,
@@ -123,6 +132,7 @@ export {
   type SubscriptionFetchCostsResponse,
   type SubscriptionFetchScheduleResponse,
   type SubscriptionPriceIntervalsResponse,
+  type SubscriptionRedeemCouponResponse,
   type SubscriptionSchedulePlanChangeResponse,
   type SubscriptionTriggerPhaseResponse,
   type SubscriptionUnscheduleCancellationResponse,
@@ -138,6 +148,7 @@ export {
   type SubscriptionFetchScheduleParams,
   type SubscriptionFetchUsageParams,
   type SubscriptionPriceIntervalsParams,
+  type SubscriptionRedeemCouponParams,
   type SubscriptionSchedulePlanChangeParams,
   type SubscriptionTriggerPhaseParams,
   type SubscriptionUnscheduleFixedFeeQuantityUpdatesParams,

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

@@ -115,7 +115,7 @@ export interface InvoiceLineItemCreateResponse {
    * For more on the types of prices, see
    * [the core concepts documentation](/core-concepts#plan-and-price)
    */
-  price: PricesAPI.Price | null;
+  price: PricesAPI.Price;
 
   /**
    * Either the fixed fee quantity or the usage during the service period.
@@ -166,10 +166,15 @@ export namespace InvoiceLineItemCreateResponse {
     amount: string;
 
     /**
-     * The price IDs that this adjustment applies to.
+     * @deprecated The price IDs that this adjustment applies to.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this adjustment to.
+     */
+    filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
+
     /**
      * True for adjustments that apply to an entire invocice, false for adjustments
      * that apply to only one price.
@@ -188,6 +193,25 @@ export namespace InvoiceLineItemCreateResponse {
     usage_discount: number;
   }
 
+  export namespace MonetaryUsageDiscountAdjustment {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface MonetaryAmountDiscountAdjustment {
     id: string;
 
@@ -205,10 +229,15 @@ export namespace InvoiceLineItemCreateResponse {
     amount_discount: string;
 
     /**
-     * The price IDs that this adjustment applies to.
+     * @deprecated The price IDs that this adjustment applies to.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this adjustment to.
+     */
+    filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
+
     /**
      * True for adjustments that apply to an entire invocice, false for adjustments
      * that apply to only one price.
@@ -221,6 +250,25 @@ export namespace InvoiceLineItemCreateResponse {
     reason: string | null;
   }
 
+  export namespace MonetaryAmountDiscountAdjustment {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface MonetaryPercentageDiscountAdjustment {
     id: string;
 
@@ -232,10 +280,15 @@ export namespace InvoiceLineItemCreateResponse {
     amount: string;
 
     /**
-     * The price IDs that this adjustment applies to.
+     * @deprecated The price IDs that this adjustment applies to.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this adjustment to.
+     */
+    filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
+
     /**
      * True for adjustments that apply to an entire invocice, false for adjustments
      * that apply to only one price.
@@ -254,6 +307,25 @@ export namespace InvoiceLineItemCreateResponse {
     reason: string | null;
   }
 
+  export namespace MonetaryPercentageDiscountAdjustment {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface MonetaryMinimumAdjustment {
     id: string;
 
@@ -265,10 +337,15 @@ export namespace InvoiceLineItemCreateResponse {
     amount: string;
 
     /**
-     * The price IDs that this adjustment applies to.
+     * @deprecated The price IDs that this adjustment applies to.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this adjustment to.
+     */
+    filters: Array<MonetaryMinimumAdjustment.Filter>;
+
     /**
      * True for adjustments that apply to an entire invocice, false for adjustments
      * that apply to only one price.
@@ -292,6 +369,25 @@ export namespace InvoiceLineItemCreateResponse {
     reason: string | null;
   }
 
+  export namespace MonetaryMinimumAdjustment {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface MonetaryMaximumAdjustment {
     id: string;
 
@@ -303,10 +399,15 @@ export namespace InvoiceLineItemCreateResponse {
     amount: string;
 
     /**
-     * The price IDs that this adjustment applies to.
+     * @deprecated The price IDs that this adjustment applies to.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this adjustment to.
+     */
+    filters: Array<MonetaryMaximumAdjustment.Filter>;
+
     /**
      * True for adjustments that apply to an entire invocice, false for adjustments
      * that apply to only one price.
@@ -325,38 +426,105 @@ export namespace InvoiceLineItemCreateResponse {
     reason: string | null;
   }
 
+  export namespace MonetaryMaximumAdjustment {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   /**
    * @deprecated This field is deprecated in favor of `adjustments`.
    */
   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.
+     * @deprecated 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>;
 
+    /**
+     * The filters that determine which prices to apply this maximum to.
+     */
+    filters: Array<Maximum.Filter>;
+
     /**
      * Maximum amount applied
      */
     maximum_amount: string;
   }
 
+  export namespace Maximum {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   /**
    * @deprecated This field is deprecated in favor of `adjustments`.
    */
   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.
+     * @deprecated 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>;
 
+    /**
+     * The filters that determine which prices to apply this minimum to.
+     */
+    filters: Array<Minimum.Filter>;
+
     /**
      * Minimum amount applied
      */
     minimum_amount: string;
   }
 
+  export namespace Minimum {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface MatrixSubLineItem {
     /**
      * The total amount for this sub line item.