orb-billing 4.21.0 → 4.23.0

package/src/index.ts

@@ -342,9 +342,13 @@ export namespace Orb {
   export import AlertCreateForExternalCustomerParams = API.AlertCreateForExternalCustomerParams;
   export import AlertCreateForSubscriptionParams = API.AlertCreateForSubscriptionParams;
 
+  export import AmountDiscount = API.AmountDiscount;
   export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
   export import Discount = API.Discount;
+  export import InvoiceLevelDiscount = API.InvoiceLevelDiscount;
   export import PaginationMetadata = API.PaginationMetadata;
+  export import PercentageDiscount = API.PercentageDiscount;
+  export import TrialDiscount = API.TrialDiscount;
 }
 
 export default Orb;

package/src/resources/coupons/coupons.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
 import * as CouponsAPI from './coupons';
+import * as Shared from '../shared';
 import * as SubscriptionsAPI from './subscriptions';
 import { Page, type PageParams } from '../../pagination';
 
@@ -112,7 +113,7 @@ export interface Coupon {
    */
   archived_at: string | null;
 
-  discount: Coupon.PercentageDiscount | Coupon.AmountDiscount;
+  discount: Shared.PercentageDiscount | Shared.AmountDiscount;
 
   /**
    * This allows for a coupon's discount to apply for a limited time (determined in
@@ -137,43 +138,6 @@ export interface Coupon {
   times_redeemed: number;
 }
 
-export namespace Coupon {
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'percentage';
-
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
-    percentage_discount: number;
-
-    reason?: string | null;
-  }
-
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amount_discount: string;
-
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'amount';
-
-    reason?: string | null;
-  }
-}
-
 export interface CouponCreateParams {
   discount: CouponCreateParams.NewCouponPercentageDiscount | CouponCreateParams.NewCouponAmountDiscount;
 

package/src/resources/customers/costs.ts

@@ -119,23 +119,6 @@ export class Costs extends APIResource {
    * You can see this sliced timeframe visualized
    * [here](https://i.imgur.com/TXhYgme.png).
    *
-   * ## Grouping by custom attributes
-   *
-   * In order to view costs grouped by a specific _attribute_ that each event is
-   * tagged with (i.e. `cluster`), you can additionally specify a `group_by` key. The
-   * `group_by` key denotes the event property on which to group.
-   *
-   * When returning grouped costs, a separate `price_group` object in the
-   * `per_price_costs` array is returned for each value of the `group_by` key present
-   * in your events. The `subtotal` value of the `per_price_costs` object is the sum
-   * of each `price_group`'s total.
-   *
-   * Orb expects events will contain values in the `properties` dictionary that
-   * correspond to the `group_by` key specified. By default, Orb will return a `null`
-   * group (i.e. events that match the metric but do not have the key set).
-   * Currently, it is only possible to view costs grouped by a single attribute at a
-   * time.
-   *
    * ### Matrix prices
    *
    * When a price uses matrix pricing, it's important to view costs grouped by those
@@ -272,23 +255,6 @@ export class Costs extends APIResource {
    * You can see this sliced timeframe visualized
    * [here](https://i.imgur.com/TXhYgme.png).
    *
-   * ## Grouping by custom attributes
-   *
-   * In order to view costs grouped by a specific _attribute_ that each event is
-   * tagged with (i.e. `cluster`), you can additionally specify a `group_by` key. The
-   * `group_by` key denotes the event property on which to group.
-   *
-   * When returning grouped costs, a separate `price_group` object in the
-   * `per_price_costs` array is returned for each value of the `group_by` key present
-   * in your events. The `subtotal` value of the `per_price_costs` object is the sum
-   * of each `price_group`'s total.
-   *
-   * Orb expects events will contain values in the `properties` dictionary that
-   * correspond to the `group_by` key specified. By default, Orb will return a `null`
-   * group (i.e. events that match the metric but do not have the key set).
-   * Currently, it is only possible to view costs grouped by a single attribute at a
-   * time.
-   *
    * ### Matrix prices
    *
    * When a price uses matrix pricing, it's important to view costs grouped by those

package/src/resources/customers/customers.ts

@@ -197,6 +197,8 @@ export interface Customer {
 
   email_delivery: boolean;
 
+  exempt_from_automated_tax: boolean | null;
+
   /**
    * An optional user-defined ID for this customer resource, used throughout the
    * system as an alias for this Customer. Use this field to identify a customer by
@@ -736,6 +738,11 @@ export interface CustomerCreateParams {
 
   shipping_address?: CustomerCreateParams.ShippingAddress | null;
 
+  tax_configuration?:
+    | CustomerCreateParams.NewAvalaraTaxConfiguration
+    | CustomerCreateParams.NewTaxJarConfiguration
+    | null;
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -900,6 +907,20 @@ export namespace CustomerCreateParams {
     state?: string | null;
   }
 
+  export interface NewAvalaraTaxConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'avalara';
+
+    tax_exemption_code?: string | null;
+  }
+
+  export interface NewTaxJarConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'taxjar';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1235,6 +1256,11 @@ export interface CustomerUpdateParams {
 
   shipping_address?: CustomerUpdateParams.ShippingAddress | null;
 
+  tax_configuration?:
+    | CustomerUpdateParams.NewAvalaraTaxConfiguration
+    | CustomerUpdateParams.NewTaxJarConfiguration
+    | null;
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1392,6 +1418,20 @@ export namespace CustomerUpdateParams {
     state?: string | null;
   }
 
+  export interface NewAvalaraTaxConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'avalara';
+
+    tax_exemption_code?: string | null;
+  }
+
+  export interface NewTaxJarConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'taxjar';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1737,6 +1777,11 @@ export interface CustomerUpdateByExternalIDParams {
 
   shipping_address?: CustomerUpdateByExternalIDParams.ShippingAddress | null;
 
+  tax_configuration?:
+    | CustomerUpdateByExternalIDParams.NewAvalaraTaxConfiguration
+    | CustomerUpdateByExternalIDParams.NewTaxJarConfiguration
+    | null;
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.
@@ -1894,6 +1939,20 @@ export namespace CustomerUpdateByExternalIDParams {
     state?: string | null;
   }
 
+  export interface NewAvalaraTaxConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'avalara';
+
+    tax_exemption_code?: string | null;
+  }
+
+  export interface NewTaxJarConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'taxjar';
+  }
+
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
    * added to the headers of invoices.

package/src/resources/invoices.ts

@@ -284,13 +284,13 @@ export interface Invoice {
   customer_tax_id: Invoice.CustomerTaxID | null;
 
   /**
-   * This field is deprecated in favor of `discounts`. If a `discounts` list is
-   * provided, the first discount in the list will be returned. If the list is empty,
-   * `None` will be returned.
+   * @deprecated: This field is deprecated in favor of `discounts`. If a `discounts`
+   * list is provided, the first discount in the list will be returned. If the list
+   * is empty, `None` will be returned.
    */
-  discount: Invoice.PercentageDiscount | Invoice.AmountDiscount | Invoice.TrialDiscount | null;
+  discount: Shared.InvoiceLevelDiscount | null;
 
-  discounts: Array<Invoice.PercentageDiscount | Invoice.AmountDiscount | Invoice.TrialDiscount>;
+  discounts: Array<Shared.InvoiceLevelDiscount>;
 
   /**
    * When the invoice payment is due.
@@ -831,120 +831,6 @@ export namespace Invoice {
     value: string;
   }
 
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'percentage';
-
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
-    percentage_discount: number;
-
-    reason?: string | null;
-  }
-
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amount_discount: string;
-
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'amount';
-
-    reason?: string | null;
-  }
-
-  export interface TrialDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'trial';
-
-    reason?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_amount_discount?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_percentage_discount?: number | null;
-  }
-
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'percentage';
-
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
-    percentage_discount: number;
-
-    reason?: string | null;
-  }
-
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amount_discount: string;
-
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'amount';
-
-    reason?: string | null;
-  }
-
-  export interface TrialDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'trial';
-
-    reason?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_amount_discount?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_percentage_discount?: number | null;
-  }
-
   export interface LineItem {
     /**
      * A unique ID for this line item.
@@ -1572,21 +1458,13 @@ export interface InvoiceFetchUpcomingResponse {
   customer_tax_id: InvoiceFetchUpcomingResponse.CustomerTaxID | null;
 
   /**
-   * This field is deprecated in favor of `discounts`. If a `discounts` list is
-   * provided, the first discount in the list will be returned. If the list is empty,
-   * `None` will be returned.
+   * @deprecated: This field is deprecated in favor of `discounts`. If a `discounts`
+   * list is provided, the first discount in the list will be returned. If the list
+   * is empty, `None` will be returned.
    */
-  discount:
-    | InvoiceFetchUpcomingResponse.PercentageDiscount
-    | InvoiceFetchUpcomingResponse.AmountDiscount
-    | InvoiceFetchUpcomingResponse.TrialDiscount
-    | null;
+  discount: Shared.InvoiceLevelDiscount | null;
 
-  discounts: Array<
-    | InvoiceFetchUpcomingResponse.PercentageDiscount
-    | InvoiceFetchUpcomingResponse.AmountDiscount
-    | InvoiceFetchUpcomingResponse.TrialDiscount
-  >;
+  discounts: Array<Shared.InvoiceLevelDiscount>;
 
   /**
    * When the invoice payment is due.
@@ -2127,120 +2005,6 @@ export namespace InvoiceFetchUpcomingResponse {
     value: string;
   }
 
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'percentage';
-
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
-    percentage_discount: number;
-
-    reason?: string | null;
-  }
-
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amount_discount: string;
-
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'amount';
-
-    reason?: string | null;
-  }
-
-  export interface TrialDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'trial';
-
-    reason?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_amount_discount?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_percentage_discount?: number | null;
-  }
-
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'percentage';
-
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
-    percentage_discount: number;
-
-    reason?: string | null;
-  }
-
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amount_discount: string;
-
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'amount';
-
-    reason?: string | null;
-  }
-
-  export interface TrialDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
-    discount_type: 'trial';
-
-    reason?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_amount_discount?: string | null;
-
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trial_percentage_discount?: number | null;
-  }
-
   export interface LineItem {
     /**
      * A unique ID for this line item.

package/src/resources/plans/plans.ts

@@ -320,6 +320,7 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanUnitWithProrationPrice
     | PlanCreateParams.NewPlanGroupedAllocationPrice
     | PlanCreateParams.NewPlanGroupedWithProratedMinimumPrice
+    | PlanCreateParams.NewPlanGroupedWithMeteredMinimumPrice
     | PlanCreateParams.NewPlanBulkWithProrationPrice
   >;
 
@@ -2444,6 +2445,119 @@ export namespace PlanCreateParams {
     }
   }
 
+  export interface NewPlanGroupedWithMeteredMinimumPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    grouped_with_metered_minimum_config: Record<string, unknown>;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'grouped_with_metered_minimum';
+
+    /**
+     * 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?: NewPlanGroupedWithMeteredMinimumPrice.BillingCycleConfiguration | null;
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+     * price is billed.
+     */
+    currency?: string | 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?: NewPlanGroupedWithMeteredMinimumPrice.InvoicingCycleConfiguration | 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;
+  }
+
+  export namespace NewPlanGroupedWithMeteredMinimumPrice {
+    /**
+     * For custom cadence: specifies the duration of the billing period in days or
+     * months.
+     */
+    export interface BillingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+
+    /**
+     * Within each billing cycle, specifies the cadence at which invoices are produced.
+     * If unspecified, a single invoice is produced per billing cycle.
+     */
+    export interface InvoicingCycleConfiguration {
+      /**
+       * The duration of the billing period.
+       */
+      duration: number;
+
+      /**
+       * The unit of billing period duration.
+       */
+      duration_unit: 'day' | 'month';
+    }
+  }
+
   export interface NewPlanBulkWithProrationPrice {
     bulk_with_proration_config: Record<string, unknown>;