orb-billing 4.55.0 → 4.57.0

package/resources/subscriptions.d.ts

@@ -2436,18 +2436,13 @@ export declare namespace SubscriptionFetchCostsResponse {
     namespace Data {
         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.
              */
@@ -6522,6 +6517,10 @@ export declare namespace SubscriptionCreateParams {
         }
     }
     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.
@@ -6567,6 +6566,29 @@ export declare namespace SubscriptionCreateParams {
         start_date?: string | null;
     }
     namespace AddPrice {
+        /**
+         * The definition of a new allocation price to create and add to the subscription.
+         */
+        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;
+        }
         interface Discount {
             discount_type: 'percentage' | 'usage' | 'amount';
             /**
@@ -8634,6 +8656,10 @@ export declare namespace SubscriptionCreateParams {
          * The id of the price on the plan to replace in the subscription.
          */
         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.
@@ -8667,6 +8693,29 @@ export declare namespace SubscriptionCreateParams {
         price_id?: string | null;
     }
     namespace ReplacePrice {
+        /**
+         * The definition of a new allocation price to create and add to the subscription.
+         */
+        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;
+        }
         interface Discount {
             discount_type: 'percentage' | 'usage' | 'amount';
             /**
@@ -10659,6 +10708,12 @@ export interface SubscriptionCancelParams {
      * Determines the timing of subscription cancellation
      */
     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`.
@@ -10736,6 +10791,12 @@ export interface SubscriptionPriceIntervalsParams {
      * A list of adjustments to add to the subscription.
      */
     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.
      */
@@ -10786,7 +10847,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
         /**
          * The definition of a new price to create and add to the subscription.
          */
-        price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingMaxGroupTieredPackagePrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | Add.NewFloatingScalableMatrixWithUnitPricingPrice | Add.NewFloatingScalableMatrixWithTieredPricingPrice | null;
+        price?: Add.NewFloatingUnitPrice | Add.NewFloatingPackagePrice | Add.NewFloatingMatrixPrice | Add.NewFloatingMatrixWithAllocationPrice | Add.NewFloatingTieredPrice | Add.NewFloatingTieredBpsPrice | Add.NewFloatingBpsPrice | Add.NewFloatingBulkBpsPrice | Add.NewFloatingBulkPrice | Add.NewFloatingThresholdTotalAmountPrice | Add.NewFloatingTieredPackagePrice | Add.NewFloatingGroupedTieredPrice | Add.NewFloatingMaxGroupTieredPackagePrice | Add.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingMatrixWithDisplayNamePrice | Add.NewFloatingBulkWithProrationPrice | Add.NewFloatingGroupedTieredPackagePrice | Add.NewFloatingScalableMatrixWithUnitPricingPrice | Add.NewFloatingScalableMatrixWithTieredPricingPrice | Add.NewFloatingCumulativeGroupedBulkPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -13537,6 +13598,99 @@ export declare namespace SubscriptionPriceIntervalsParams {
                 duration_unit: 'day' | 'month';
             }
         }
+        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;
+        }
+        namespace NewFloatingCumulativeGroupedBulkPrice {
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            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.
+             */
+            interface InvoicingCycleConfiguration {
+                /**
+                 * The duration of the billing period.
+                 */
+                duration: number;
+                /**
+                 * The unit of billing period duration.
+                 */
+                duration_unit: 'day' | 'month';
+            }
+        }
     }
     interface AddAdjustment {
         /**
@@ -13895,6 +14049,10 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         }
     }
     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.
@@ -13940,6 +14098,29 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         start_date?: string | null;
     }
     namespace AddPrice {
+        /**
+         * The definition of a new allocation price to create and add to the subscription.
+         */
+        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;
+        }
         interface Discount {
             discount_type: 'percentage' | 'usage' | 'amount';
             /**
@@ -16007,6 +16188,10 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
          * The id of the price on the plan to replace in the subscription.
          */
         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.
@@ -16040,6 +16225,29 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         price_id?: string | null;
     }
     namespace ReplacePrice {
+        /**
+         * The definition of a new allocation price to create and add to the subscription.
+         */
+        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;
+        }
         interface Discount {
             discount_type: 'percentage' | 'usage' | 'amount';
             /**
@@ -17987,6 +18195,12 @@ export declare 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.
@@ -18005,6 +18219,12 @@ export interface SubscriptionUpdateFixedFeeQuantityParams {
      */
     price_id: string;
     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