orb-billing 4.55.0 → 4.57.0

package/src/resources/subscriptions.ts

@@ -2999,19 +2999,15 @@ export namespace SubscriptionFetchCostsResponse {
   export namespace Data {
     export interface PerPriceCost {
       /**
-       * The Price resource represents a price that can be billed on a subscription,
-       * resulting in a charge on an invoice in the form of an invoice line item. Prices
-       * take a quantity and determine an amount to bill.
-       *
-       * Orb supports a few different pricing models out of the box. Each of these models
-       * is serialized differently in a given Price object. The model_type field
-       * determines the key for the configuration object that is present.
-       *
-       * For more on the types of prices, see
-       * [the core concepts documentation](/core-concepts#plan-and-price)
+       * The price object
        */
       price: PricesAPI.Price;
 
+      /**
+       * The price the cost is associated with
+       */
+      price_id: string;
+
       /**
        * Price's contributions for the timeframe, excluding any minimums and discounts.
        */
@@ -8156,6 +8152,11 @@ export namespace SubscriptionCreateParams {
   }
 
   export interface AddPrice {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    allocation_price?: AddPrice.AllocationPrice | null;
+
     /**
      * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
      * discounts for this price.
@@ -8229,6 +8230,33 @@ export namespace SubscriptionCreateParams {
   }
 
   export namespace AddPrice {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    export interface AllocationPrice {
+      /**
+       * An amount of the currency to allocate to the customer at the specified cadence.
+       */
+      amount: string;
+
+      /**
+       * The cadence at which to allocate the amount to the customer.
+       */
+      cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+      /**
+       * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+       * this price.
+       */
+      currency: string;
+
+      /**
+       * Whether the allocated amount should expire at the end of the cadence or roll
+       * over to the next period.
+       */
+      expires_at_end_of_cadence: boolean;
+    }
+
     export interface Discount {
       discount_type: 'percentage' | 'usage' | 'amount';
 
@@ -10721,6 +10749,11 @@ export namespace SubscriptionCreateParams {
      */
     replaces_price_id: string;
 
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    allocation_price?: ReplacePrice.AllocationPrice | null;
+
     /**
      * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
      * discounts for the replacement price.
@@ -10780,6 +10813,33 @@ export namespace SubscriptionCreateParams {
   }
 
   export namespace ReplacePrice {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    export interface AllocationPrice {
+      /**
+       * An amount of the currency to allocate to the customer at the specified cadence.
+       */
+      amount: string;
+
+      /**
+       * The cadence at which to allocate the amount to the customer.
+       */
+      cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+      /**
+       * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+       * this price.
+       */
+      currency: string;
+
+      /**
+       * Whether the allocated amount should expire at the end of the cadence or roll
+       * over to the next period.
+       */
+      expires_at_end_of_cadence: boolean;
+    }
+
     export interface Discount {
       discount_type: 'percentage' | 'usage' | 'amount';
 
@@ -13175,6 +13235,13 @@ export interface SubscriptionCancelParams {
    */
   cancel_option: 'end_of_subscription_term' | 'immediate' | 'requested_date';
 
+  /**
+   * If false, this request will fail if it would void an issued invoice or create a
+   * credit note. Consider using this as a safety mechanism if you do not expect
+   * existing invoices to be changed.
+   */
+  allow_invoice_credit_or_void?: boolean | null;
+
   /**
    * The date that the cancellation should take effect. This parameter can only be
    * passed if the `cancel_option` is `requested_date`.
@@ -13273,6 +13340,13 @@ export interface SubscriptionPriceIntervalsParams {
    */
   add_adjustments?: Array<SubscriptionPriceIntervalsParams.AddAdjustment>;
 
+  /**
+   * If false, this request will fail if it would void an issued invoice or create a
+   * credit note. Consider using this as a safety mechanism if you do not expect
+   * existing invoices to be changed.
+   */
+  allow_invoice_credit_or_void?: boolean | null;
+
   /**
    * A list of price intervals to edit on the subscription.
    */
@@ -13365,6 +13439,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Add.NewFloatingGroupedTieredPackagePrice
       | Add.NewFloatingScalableMatrixWithUnitPricingPrice
       | Add.NewFloatingScalableMatrixWithTieredPricingPrice
+      | Add.NewFloatingCumulativeGroupedBulkPrice
       | null;
 
     /**
@@ -16674,6 +16749,118 @@ export namespace SubscriptionPriceIntervalsParams {
         duration_unit: 'day' | 'month';
       }
     }
+
+    export interface NewFloatingCumulativeGroupedBulkPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      cumulative_grouped_bulk_config: Record<string, unknown>;
+
+      /**
+       * 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: 'cumulative_grouped_bulk';
+
+      /**
+       * 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?: NewFloatingCumulativeGroupedBulkPrice.BillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | 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?: NewFloatingCumulativeGroupedBulkPrice.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 NewFloatingCumulativeGroupedBulkPrice {
+      /**
+       * 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 AddAdjustment {
@@ -17127,6 +17314,11 @@ export namespace SubscriptionSchedulePlanChangeParams {
   }
 
   export interface AddPrice {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    allocation_price?: AddPrice.AllocationPrice | null;
+
     /**
      * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
      * discounts for this price.
@@ -17200,6 +17392,33 @@ export namespace SubscriptionSchedulePlanChangeParams {
   }
 
   export namespace AddPrice {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    export interface AllocationPrice {
+      /**
+       * An amount of the currency to allocate to the customer at the specified cadence.
+       */
+      amount: string;
+
+      /**
+       * The cadence at which to allocate the amount to the customer.
+       */
+      cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+      /**
+       * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+       * this price.
+       */
+      currency: string;
+
+      /**
+       * Whether the allocated amount should expire at the end of the cadence or roll
+       * over to the next period.
+       */
+      expires_at_end_of_cadence: boolean;
+    }
+
     export interface Discount {
       discount_type: 'percentage' | 'usage' | 'amount';
 
@@ -19692,6 +19911,11 @@ export namespace SubscriptionSchedulePlanChangeParams {
      */
     replaces_price_id: string;
 
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    allocation_price?: ReplacePrice.AllocationPrice | null;
+
     /**
      * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
      * discounts for the replacement price.
@@ -19751,6 +19975,33 @@ export namespace SubscriptionSchedulePlanChangeParams {
   }
 
   export namespace ReplacePrice {
+    /**
+     * The definition of a new allocation price to create and add to the subscription.
+     */
+    export interface AllocationPrice {
+      /**
+       * An amount of the currency to allocate to the customer at the specified cadence.
+       */
+      amount: string;
+
+      /**
+       * The cadence at which to allocate the amount to the customer.
+       */
+      cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+      /**
+       * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
+       * this price.
+       */
+      currency: string;
+
+      /**
+       * Whether the allocated amount should expire at the end of the cadence or roll
+       * over to the next period.
+       */
+      expires_at_end_of_cadence: boolean;
+    }
+
     export interface Discount {
       discount_type: 'percentage' | 'usage' | 'amount';
 
@@ -22088,6 +22339,13 @@ export namespace SubscriptionSchedulePlanChangeParams {
 }
 
 export interface SubscriptionTriggerPhaseParams {
+  /**
+   * If false, this request will fail if it would void an issued invoice or create a
+   * credit note. Consider using this as a safety mechanism if you do not expect
+   * existing invoices to be changed.
+   */
+  allow_invoice_credit_or_void?: boolean | null;
+
   /**
    * The date on which the phase change should take effect. If not provided, defaults
    * to today in the customer's timezone.
@@ -22110,6 +22368,13 @@ export interface SubscriptionUpdateFixedFeeQuantityParams {
 
   quantity: number;
 
+  /**
+   * If false, this request will fail if it would void an issued invoice or create a
+   * credit note. Consider using this as a safety mechanism if you do not expect
+   * existing invoices to be changed.
+   */
+  allow_invoice_credit_or_void?: boolean | null;
+
   /**
    * Determines when the change takes effect. Note that if `effective_date` is
    * specified, this defaults to `effective_date`. Otherwise, this defaults to

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.55.0'; // x-release-please-version
+export const VERSION = '4.57.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.55.0";
+export declare const VERSION = "4.57.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.55.0'; // x-release-please-version
+exports.VERSION = '4.57.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.55.0'; // x-release-please-version
+export const VERSION = '4.57.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map