orb-billing 5.5.1 → 5.7.0

package/src/resources/customers/customers.ts

@@ -233,6 +233,13 @@ export interface Customer {
 
   auto_collection: boolean;
 
+  /**
+   * Whether invoices for this customer should be automatically issued. If true,
+   * invoices will be automatically issued. If false, invoices will require manual
+   * approval. If null, inherits the account-level setting.
+   */
+  auto_issuance: boolean | null;
+
   /**
    * The customer's current balance in their currency.
    */
@@ -547,7 +554,8 @@ export interface CustomerCreateParams {
 
   /**
    * Additional email addresses for this customer. If populated, these email
-   * addresses will be CC'd for customer communications.
+   * addresses will be CC'd for customer communications. The total number of email
+   * addresses (including the primary email) cannot exceed 50.
    */
   additional_emails?: Array<string> | null;
 
@@ -558,6 +566,14 @@ export interface CustomerCreateParams {
    */
   auto_collection?: boolean | null;
 
+  /**
+   * Used to determine if invoices for this customer will be automatically issued. If
+   * true, invoices will be automatically issued. If false, invoices will require
+   * manual approval. If `null` is specified, the customer's auto issuance setting
+   * will be inherited from the account-level setting.
+   */
+  auto_issuance?: boolean | null;
+
   billing_address?: AddressInput | null;
 
   /**
@@ -604,7 +620,12 @@ export interface CustomerCreateParams {
 
   shipping_address?: AddressInput | null;
 
-  tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
+  tax_configuration?:
+    | NewAvalaraTaxConfiguration
+    | NewTaxJarConfiguration
+    | NewSphereConfiguration
+    | CustomerCreateParams.NewNumeralConfiguration
+    | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -762,12 +783,21 @@ export interface CustomerCreateParams {
   timezone?: string | null;
 }
 
+export namespace CustomerCreateParams {
+  export interface NewNumeralConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'numeral';
+  }
+}
+
 export interface CustomerUpdateParams {
   accounting_sync_configuration?: NewAccountingSyncConfiguration | null;
 
   /**
    * Additional email addresses for this customer. If populated, these email
-   * addresses will be CC'd for customer communications.
+   * addresses will be CC'd for customer communications. The total number of email
+   * addresses (including the primary email) cannot exceed 50.
    */
   additional_emails?: Array<string> | null;
 
@@ -778,6 +808,14 @@ export interface CustomerUpdateParams {
    */
   auto_collection?: boolean | null;
 
+  /**
+   * Used to determine if invoices for this customer will be automatically issued. If
+   * true, invoices will be automatically issued. If false, invoices will require
+   * manual approval.If `null` is specified, the customer's auto issuance setting
+   * will be inherited from the account-level setting.
+   */
+  auto_issuance?: boolean | null;
+
   billing_address?: AddressInput | null;
 
   /**
@@ -840,7 +878,12 @@ export interface CustomerUpdateParams {
 
   shipping_address?: AddressInput | null;
 
-  tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
+  tax_configuration?:
+    | NewAvalaraTaxConfiguration
+    | NewTaxJarConfiguration
+    | NewSphereConfiguration
+    | CustomerUpdateParams.NewNumeralConfiguration
+    | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -991,6 +1034,14 @@ export interface CustomerUpdateParams {
   tax_id?: Shared.CustomerTaxID | null;
 }
 
+export namespace CustomerUpdateParams {
+  export interface NewNumeralConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'numeral';
+  }
+}
+
 export interface CustomerListParams extends PageParams {
   'created_at[gt]'?: string | null;
 
@@ -1006,7 +1057,8 @@ export interface CustomerUpdateByExternalIDParams {
 
   /**
    * Additional email addresses for this customer. If populated, these email
-   * addresses will be CC'd for customer communications.
+   * addresses will be CC'd for customer communications. The total number of email
+   * addresses (including the primary email) cannot exceed 50.
    */
   additional_emails?: Array<string> | null;
 
@@ -1017,6 +1069,14 @@ export interface CustomerUpdateByExternalIDParams {
    */
   auto_collection?: boolean | null;
 
+  /**
+   * Used to determine if invoices for this customer will be automatically issued. If
+   * true, invoices will be automatically issued. If false, invoices will require
+   * manual approval.If `null` is specified, the customer's auto issuance setting
+   * will be inherited from the account-level setting.
+   */
+  auto_issuance?: boolean | null;
+
   billing_address?: AddressInput | null;
 
   /**
@@ -1079,7 +1139,12 @@ export interface CustomerUpdateByExternalIDParams {
 
   shipping_address?: AddressInput | null;
 
-  tax_configuration?: NewAvalaraTaxConfiguration | NewTaxJarConfiguration | NewSphereConfiguration | null;
+  tax_configuration?:
+    | NewAvalaraTaxConfiguration
+    | NewTaxJarConfiguration
+    | NewSphereConfiguration
+    | CustomerUpdateByExternalIDParams.NewNumeralConfiguration
+    | null;
 
   /**
    * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -1230,6 +1295,14 @@ export interface CustomerUpdateByExternalIDParams {
   tax_id?: Shared.CustomerTaxID | null;
 }
 
+export namespace CustomerUpdateByExternalIDParams {
+  export interface NewNumeralConfiguration {
+    tax_exempt: boolean;
+
+    tax_provider: 'numeral';
+  }
+}
+
 Customers.CustomersPage = CustomersPage;
 Customers.Costs = Costs;
 Customers.Credits = Credits;

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

@@ -17,7 +17,7 @@ export class DimensionalPriceGroups extends APIResource {
 
   /**
    * A dimensional price group is used to partition the result of a billable metric
-   * by a set of dimensions. Prices in a price group must specify the parition used
+   * by a set of dimensions. Prices in a price group must specify the partition used
    * to derive their usage.
    *
    * For example, suppose we have a billable metric that measures the number of

package/src/resources/events/backfills.ts

@@ -39,8 +39,8 @@ export class Backfills extends APIResource {
    *
    * When `replace_existing_events` is `true`, this indicates that existing events in
    * the timeframe should no longer be counted towards invoiced usage. In this
-   * scenario, the parameter `filter` can be optionally added which enables filtering
-   * using
+   * scenario, the parameter `deprecation_filter` can be optionally added which
+   * enables filtering using
    * [computed properties](/extensibility/advanced-metrics#computed-properties). The
    * expressiveness of computed properties allows you to deprecate existing events
    * based on both a period of time and specific property values.

package/src/resources/index.ts

@@ -129,8 +129,6 @@ export {
   SubscriptionFetchScheduleResponsesPage,
   Subscriptions,
   type DiscountOverride,
-  type NewSubscriptionBPSPrice,
-  type NewSubscriptionBulkBPSPrice,
   type NewSubscriptionBulkPrice,
   type NewSubscriptionBulkWithProrationPrice,
   type NewSubscriptionCumulativeGroupedBulkPrice,
@@ -143,13 +141,12 @@ export {
   type NewSubscriptionMatrixWithAllocationPrice,
   type NewSubscriptionMatrixWithDisplayNamePrice,
   type NewSubscriptionMaxGroupTieredPackagePrice,
+  type NewSubscriptionMinimumCompositePrice,
   type NewSubscriptionPackagePrice,
   type NewSubscriptionPackageWithAllocationPrice,
   type NewSubscriptionScalableMatrixWithTieredPricingPrice,
   type NewSubscriptionScalableMatrixWithUnitPricingPrice,
   type NewSubscriptionThresholdTotalAmountPrice,
-  type NewSubscriptionTierWithProrationPrice,
-  type NewSubscriptionTieredBPSPrice,
   type NewSubscriptionTieredPackagePrice,
   type NewSubscriptionTieredPackageWithMinimumPrice,
   type NewSubscriptionTieredPrice,

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

@@ -136,7 +136,7 @@ export interface InvoiceLineItemCreateResponse {
   sub_line_items: Array<Shared.MatrixSubLineItem | Shared.TierSubLineItem | Shared.OtherSubLineItem>;
 
   /**
-   * The line amount before before any adjustments.
+   * The line amount before any adjustments.
    */
   subtotal: string;
 

package/src/resources/invoices.ts

@@ -107,8 +107,8 @@ export class Invoices extends APIResource {
   }
 
   /**
-   * This endpoint allows an invoice's status to be set the `paid` status. This can
-   * only be done to invoices that are in the `issued` status.
+   * This endpoint allows an invoice's status to be set to the `paid` status. This
+   * can only be done to invoices that are in the `issued` or `synced` status.
    */
   markPaid(
     invoiceId: string,
@@ -127,8 +127,8 @@ export class Invoices extends APIResource {
   }
 
   /**
-   * This endpoint allows an invoice's status to be set the `void` status. This can
-   * only be done to invoices that are in the `issued` status.
+   * This endpoint allows an invoice's status to be set to the `void` status. This
+   * can only be done to invoices that are in the `issued` status.
    *
    * If the associated invoice has used the customer balance to change the amount
    * due, the customer balance operation will be reverted. For example, if the
@@ -543,7 +543,8 @@ export namespace InvoiceFetchUpcomingResponse {
       | 'credit_note_applied'
       | 'credit_note_voided'
       | 'overpayment_refund'
-      | 'external_payment';
+      | 'external_payment'
+      | 'small_invoice_carryover';
 
     /**
      * The value of the amount changed in the transaction.
@@ -698,7 +699,7 @@ export namespace InvoiceFetchUpcomingResponse {
     sub_line_items: Array<Shared.MatrixSubLineItem | Shared.TierSubLineItem | Shared.OtherSubLineItem>;
 
     /**
-     * The line amount before before any adjustments.
+     * The line amount before any adjustments.
      */
     subtotal: string;
 
@@ -740,6 +741,12 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     payment_provider_id: string | null;
 
+    /**
+     * URL to the downloadable PDF version of the receipt. This field will be `null`
+     * for payment attempts that did not succeed.
+     */
+    receipt_pdf: string | null;
+
     /**
      * Whether the payment attempt succeeded.
      */
@@ -773,6 +780,12 @@ export interface InvoiceCreateParams {
    */
   discount?: Shared.Discount | null;
 
+  /**
+   * An optional custom due date for the invoice. If not set, the due date will be
+   * calculated based on the `net_terms` value.
+   */
+  due_date?: (string & {}) | (string & {}) | null;
+
   /**
    * The `external_customer_id` of the `Customer` to create this invoice for. One of
    * `customer_id` and `external_customer_id` are required.
@@ -780,7 +793,8 @@ export interface InvoiceCreateParams {
   external_customer_id?: string | null;
 
   /**
-   * An optional memo to attach to the invoice.
+   * An optional memo to attach to the invoice. If no memo is provided, we will
+   * attach the default memo
    */
   memo?: string | null;
 
@@ -792,10 +806,11 @@ export interface InvoiceCreateParams {
   metadata?: { [key: string]: string | null } | null;
 
   /**
-   * Determines the difference between the invoice issue date for subscription
-   * invoices as the date that they are due. A value of '0' here represents that the
-   * invoice is due on issue, whereas a value of 30 represents that the customer has
-   * 30 days to pay the invoice.
+   * The net terms determines the due date of the invoice. Due date is calculated
+   * based on the invoice or issuance date, depending on the account's configured due
+   * date calculation method. A value of '0' here represents that the invoice is due
+   * on issue, whereas a value of '30' represents that the customer has 30 days to
+   * pay the invoice. Do not set this field if you want to set a custom due date.
    */
   net_terms?: number | null;
 
@@ -833,17 +848,35 @@ export namespace InvoiceCreateParams {
      */
     start_date: string;
 
+    /**
+     * Configuration for unit pricing
+     */
     unit_config: Shared.UnitConfig;
   }
 }
 
 export interface InvoiceUpdateParams {
+  /**
+   * An optional custom due date for the invoice. If not set, the due date will be
+   * calculated based on the `net_terms` value.
+   */
+  due_date?: (string & {}) | (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?: { [key: string]: string | null } | null;
+
+  /**
+   * The net terms determines the due date of the invoice. Due date is calculated
+   * based on the invoice or issuance date, depending on the account's configured due
+   * date calculation method. A value of '0' here represents that the invoice is due
+   * on issue, whereas a value of '30' represents that the customer has 30 days to
+   * pay the invoice. Do not set this field if you want to set a custom due date.
+   */
+  net_terms?: number | null;
 }
 
 export interface InvoiceListParams extends PageParams {

package/src/resources/plans/plans.ts

@@ -320,40 +320,300 @@ export namespace PlanCreateParams {
     plan_phase_order?: number | null;
 
     /**
-     * The price to add to the plan
+     * New plan price request body params.
      */
     price?:
       | Shared.NewPlanUnitPrice
-      | Shared.NewPlanPackagePrice
-      | Shared.NewPlanMatrixPrice
       | Shared.NewPlanTieredPrice
-      | Shared.NewPlanTieredBPSPrice
-      | Shared.NewPlanBPSPrice
-      | Shared.NewPlanBulkBPSPrice
       | Shared.NewPlanBulkPrice
+      | Shared.NewPlanPackagePrice
+      | Shared.NewPlanMatrixPrice
       | Shared.NewPlanThresholdTotalAmountPrice
       | Shared.NewPlanTieredPackagePrice
       | Shared.NewPlanTieredWithMinimumPrice
-      | Shared.NewPlanUnitWithPercentPrice
+      | Shared.NewPlanGroupedTieredPrice
+      | Shared.NewPlanTieredPackageWithMinimumPrice
       | Shared.NewPlanPackageWithAllocationPrice
-      | Shared.NewPlanTierWithProrationPrice
+      | Shared.NewPlanUnitWithPercentPrice
+      | Shared.NewPlanMatrixWithAllocationPrice
+      | Price.NewPlanTieredWithProrationPrice
       | Shared.NewPlanUnitWithProrationPrice
       | Shared.NewPlanGroupedAllocationPrice
+      | Shared.NewPlanBulkWithProrationPrice
       | Shared.NewPlanGroupedWithProratedMinimumPrice
       | Shared.NewPlanGroupedWithMeteredMinimumPrice
+      | Price.NewPlanGroupedWithMinMaxThresholdsPrice
       | Shared.NewPlanMatrixWithDisplayNamePrice
-      | Shared.NewPlanBulkWithProrationPrice
       | Shared.NewPlanGroupedTieredPackagePrice
       | Shared.NewPlanMaxGroupTieredPackagePrice
       | Shared.NewPlanScalableMatrixWithUnitPricingPrice
       | Shared.NewPlanScalableMatrixWithTieredPricingPrice
       | Shared.NewPlanCumulativeGroupedBulkPrice
-      | Shared.NewPlanTieredPackageWithMinimumPrice
-      | Shared.NewPlanMatrixWithAllocationPrice
-      | Shared.NewPlanGroupedTieredPrice
+      | Shared.NewPlanMinimumCompositePrice
       | null;
   }
 
+  export namespace Price {
+    export interface NewPlanTieredWithProrationPrice {
+      /**
+       * 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: 'tiered_with_proration';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_with_proration pricing
+       */
+      tiered_with_proration_config: NewPlanTieredWithProrationPrice.TieredWithProrationConfig;
+
+      /**
+       * 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 NewPlanTieredWithProrationPrice {
+      /**
+       * Configuration for tiered_with_proration pricing
+       */
+      export interface TieredWithProrationConfig {
+        /**
+         * Tiers for rating based on total usage quantities into the specified tier with
+         * proration
+         */
+        tiers: Array<TieredWithProrationConfig.Tier>;
+      }
+
+      export namespace TieredWithProrationConfig {
+        /**
+         * Configuration for a single tiered with proration tier
+         */
+        export interface Tier {
+          /**
+           * Inclusive tier starting value
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
+    export interface NewPlanGroupedWithMinMaxThresholdsPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for grouped_with_min_max_thresholds pricing
+       */
+      grouped_with_min_max_thresholds_config: NewPlanGroupedWithMinMaxThresholdsPrice.GroupedWithMinMaxThresholdsConfig;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'grouped_with_min_max_thresholds';
+
+      /**
+       * 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 NewPlanGroupedWithMinMaxThresholdsPrice {
+      /**
+       * Configuration for grouped_with_min_max_thresholds pricing
+       */
+      export interface GroupedWithMinMaxThresholdsConfig {
+        /**
+         * The event property used to group before applying thresholds
+         */
+        grouping_key: string;
+
+        /**
+         * The maximum amount to charge each group
+         */
+        maximum_charge: string;
+
+        /**
+         * The minimum amount to charge each group, regardless of usage
+         */
+        minimum_charge: string;
+
+        /**
+         * The base price charged per group
+         */
+        per_unit_rate: string;
+      }
+    }
+  }
+
   export interface Adjustment {
     /**
      * The definition of a new adjustment to create and add to the plan.