orb-billing 4.13.0 → 4.15.0

package/src/resources/prices/prices.ts

@@ -372,6 +372,7 @@ export type Price =
   | Price.TieredWithProrationPrice
   | Price.UnitWithProrationPrice
   | Price.GroupedAllocationPrice
+  | Price.GroupedWithProratedMinimumPrice
   | Price.BulkWithProrationPrice;
 
 export namespace Price {
@@ -2674,6 +2675,116 @@ export namespace Price {
     }
   }
 
+  export interface GroupedWithProratedMinimumPrice {
+    id: string;
+
+    billable_metric: GroupedWithProratedMinimumPrice.BillableMetric | null;
+
+    billing_cycle_configuration: GroupedWithProratedMinimumPrice.BillingCycleConfiguration;
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    conversion_rate: number | null;
+
+    created_at: string;
+
+    credit_allocation: GroupedWithProratedMinimumPrice.CreditAllocation | null;
+
+    currency: string;
+
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    grouped_with_prorated_minimum_config: Record<string, unknown>;
+
+    invoicing_cycle_configuration: GroupedWithProratedMinimumPrice.InvoicingCycleConfiguration | null;
+
+    item: GroupedWithProratedMinimumPrice.Item;
+
+    maximum: GroupedWithProratedMinimumPrice.Maximum | null;
+
+    maximum_amount: string | null;
+
+    /**
+     * User specified key-value pairs for the resource. If not present, this defaults
+     * to an empty dictionary. 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>;
+
+    minimum: GroupedWithProratedMinimumPrice.Minimum | null;
+
+    minimum_amount: string | null;
+
+    model_type: 'grouped_with_prorated_minimum';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price';
+  }
+
+  export namespace GroupedWithProratedMinimumPrice {
+    export interface BillableMetric {
+      id: string;
+    }
+
+    export interface BillingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface CreditAllocation {
+      allows_rollover: boolean;
+
+      currency: string;
+    }
+
+    export interface InvoicingCycleConfiguration {
+      duration: number;
+
+      duration_unit: 'day' | 'month';
+    }
+
+    export interface Item {
+      id: string;
+
+      name: string;
+    }
+
+    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.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Maximum amount applied
+       */
+      maximum_amount: string;
+    }
+
+    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.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * Minimum amount applied
+       */
+      minimum_amount: string;
+    }
+  }
+
   export interface BulkWithProrationPrice {
     id: string;
 
@@ -2809,6 +2920,7 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingTieredWithProrationPrice
   | PriceCreateParams.NewFloatingUnitWithProrationPrice
   | PriceCreateParams.NewFloatingGroupedAllocationPrice
+  | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice
   | PriceCreateParams.NewFloatingBulkWithProrationPrice;
 
 export namespace PriceCreateParams {
@@ -5149,6 +5261,118 @@ export namespace PriceCreateParams {
     }
   }
 
+  export interface NewFloatingGroupedWithProratedMinimumPrice {
+    /**
+     * The cadence to bill for this price on.
+     */
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+    /**
+     * An ISO 4217 currency string for which this price is billed in.
+     */
+    currency: string;
+
+    grouped_with_prorated_minimum_config: Record<string, unknown>;
+
+    /**
+     * The id of the item the plan will be associated with.
+     */
+    item_id: string;
+
+    model_type: 'grouped_with_prorated_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?: PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice.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?: PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice.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 NewFloatingGroupedWithProratedMinimumPrice {
+    /**
+     * 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 NewFloatingBulkWithProrationPrice {
     bulk_with_proration_config: Record<string, unknown>;
 

package/src/resources/subscriptions.ts

@@ -2229,18 +2229,32 @@ export namespace SubscriptionFetchScheduleResponse {
 export interface SubscriptionCreateParams {
   align_billing_with_subscription_start_date?: boolean;
 
+  /**
+   * Determines whether issued invoices for this subscription will automatically be
+   * charged with the saved payment method on the due date. If not specified, this
+   * defaults to the behavior configured for this customer.
+   */
   auto_collection?: boolean | null;
 
   aws_region?: string | null;
 
   billing_cycle_anchor_configuration?: SubscriptionCreateParams.BillingCycleAnchorConfiguration | null;
 
+  /**
+   * Redemption code to be used for this subscription. If the coupon cannot be found
+   * by its redemption code, or cannot be redeemed, an error response will be
+   * returned and the subscription creation or plan change will not be scheduled.
+   */
   coupon_redemption_code?: string | null;
 
   credits_overage_rate?: number | null;
 
   customer_id?: string | null;
 
+  /**
+   * Determines the default memo on this subscription's invoices. Note that if this
+   * is not provided, it is determined by the plan configuration.
+   */
   default_invoice_memo?: string | null;
 
   end_date?: string | null;
@@ -2257,8 +2271,16 @@ export interface SubscriptionCreateParams {
    */
   external_plan_id?: string | null;
 
+  /**
+   * The phase of the plan to start with
+   */
   initial_phase_order?: number | null;
 
+  /**
+   * When this subscription's accrued usage reaches this threshold, an invoice will
+   * be issued for the subscription. If not specified, invoices will only be issued
+   * at the end of the billing period.
+   */
   invoicing_threshold?: string | null;
 
   /**
@@ -2268,6 +2290,11 @@ export interface SubscriptionCreateParams {
    */
   metadata?: Record<string, string | null> | null;
 
+  /**
+   * The net terms determines the difference between the invoice date and the issue
+   * date for the invoice. If you intend the invoice to be due on issue, set this
+   * to 0. If not provided, this defaults to the value specified in the plan.
+   */
   net_terms?: number | null;
 
   per_credit_overage_amount?: number | null;
@@ -2296,6 +2323,7 @@ export interface SubscriptionCreateParams {
     | SubscriptionCreateParams.OverridePackageWithAllocationPrice
     | SubscriptionCreateParams.OverrideUnitWithPercentPrice
     | SubscriptionCreateParams.OverrideGroupedAllocationPrice
+    | SubscriptionCreateParams.OverrideGroupedWithProratedMinimumPrice
     | SubscriptionCreateParams.OverrideBulkWithProrationPrice
   > | null;
 
@@ -3561,6 +3589,82 @@ export namespace SubscriptionCreateParams {
     }
   }
 
+  export interface OverrideGroupedWithProratedMinimumPrice {
+    id: string;
+
+    grouped_with_prorated_minimum_config: Record<string, unknown>;
+
+    model_type: 'grouped_with_prorated_minimum';
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * The currency of the price. If not provided, the currency of the plan will be
+     * used.
+     */
+    currency?: string | null;
+
+    /**
+     * The subscription's override discount for the plan.
+     */
+    discount?: OverrideGroupedWithProratedMinimumPrice.Discount | null;
+
+    /**
+     * The starting quantity of the price, if the price is a fixed price.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The subscription's override maximum amount for the plan.
+     */
+    maximum_amount?: string | null;
+
+    /**
+     * The subscription's override minimum amount for the plan.
+     */
+    minimum_amount?: string | null;
+  }
+
+  export namespace OverrideGroupedWithProratedMinimumPrice {
+    /**
+     * The subscription's override discount for the plan.
+     */
+    export interface Discount {
+      discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
+
+      /**
+       * Only available if discount_type is `amount`.
+       */
+      amount_discount?: string | null;
+
+      /**
+       * 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> | null;
+
+      /**
+       * Only available if discount_type is `percentage`. This is a number between 0
+       * and 1.
+       */
+      percentage_discount?: number | null;
+
+      /**
+       * Only available if discount_type is `trial`
+       */
+      trial_amount_discount?: string | null;
+
+      /**
+       * Only available if discount_type is `usage`. Number of usage units that this
+       * discount is for
+       */
+      usage_discount?: number | null;
+    }
+  }
+
   export interface OverrideBulkWithProrationPrice {
     id: string;
 
@@ -3879,6 +3983,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Add.NewFloatingTieredWithProrationPrice
       | Add.NewFloatingUnitWithProrationPrice
       | Add.NewFloatingGroupedAllocationPrice
+      | Add.NewFloatingGroupedWithProratedMinimumPrice
       | Add.NewFloatingBulkWithProrationPrice
       | null;
 
@@ -6294,6 +6399,118 @@ export namespace SubscriptionPriceIntervalsParams {
       }
     }
 
+    export interface NewFloatingGroupedWithProratedMinimumPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * An ISO 4217 currency string for which this price is billed in.
+       */
+      currency: string;
+
+      grouped_with_prorated_minimum_config: Record<string, unknown>;
+
+      /**
+       * The id of the item the plan will be associated with.
+       */
+      item_id: string;
+
+      model_type: 'grouped_with_prorated_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?: NewFloatingGroupedWithProratedMinimumPrice.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?: NewFloatingGroupedWithProratedMinimumPrice.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 NewFloatingGroupedWithProratedMinimumPrice {
+      /**
+       * 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 NewFloatingBulkWithProrationPrice {
       bulk_with_proration_config: Record<string, unknown>;
 
@@ -6557,6 +6774,13 @@ export interface SubscriptionSchedulePlanChangeParams {
    */
   align_billing_with_plan_change_date?: boolean | null;
 
+  /**
+   * Determines whether issued invoices for this subscription will automatically be
+   * charged with the saved payment method on the due date. If not specified, this
+   * defaults to the behavior configured for this customer.
+   */
+  auto_collection?: boolean | null;
+
   /**
    * Reset billing periods to be aligned with the plan change's effective date or
    * start of the month. Defaults to `unchanged` which keeps subscription's existing
@@ -6573,12 +6797,18 @@ export interface SubscriptionSchedulePlanChangeParams {
   /**
    * Redemption code to be used for this subscription. If the coupon cannot be found
    * by its redemption code, or cannot be redeemed, an error response will be
-   * returned and the plan change will not be scheduled.
+   * returned and the subscription creation or plan change will not be scheduled.
    */
   coupon_redemption_code?: string | null;
 
   credits_overage_rate?: number | null;
 
+  /**
+   * Determines the default memo on this subscription's invoices. Note that if this
+   * is not provided, it is determined by the plan configuration.
+   */
+  default_invoice_memo?: string | null;
+
   /**
    * The external_plan_id of the plan that the given subscription should be switched
    * to. Note that either this property or `plan_id` must be specified.
@@ -6597,6 +6827,13 @@ export interface SubscriptionSchedulePlanChangeParams {
    */
   invoicing_threshold?: string | null;
 
+  /**
+   * The net terms determines the difference between the invoice date and the issue
+   * date for the invoice. If you intend the invoice to be due on issue, set this
+   * to 0. If not provided, this defaults to the value specified in the plan.
+   */
+  net_terms?: number | null;
+
   per_credit_overage_amount?: number | null;
 
   /**
@@ -6623,6 +6860,7 @@ export interface SubscriptionSchedulePlanChangeParams {
     | SubscriptionSchedulePlanChangeParams.OverridePackageWithAllocationPrice
     | SubscriptionSchedulePlanChangeParams.OverrideUnitWithPercentPrice
     | SubscriptionSchedulePlanChangeParams.OverrideGroupedAllocationPrice
+    | SubscriptionSchedulePlanChangeParams.OverrideGroupedWithProratedMinimumPrice
     | SubscriptionSchedulePlanChangeParams.OverrideBulkWithProrationPrice
   > | null;
 }
@@ -7863,6 +8101,82 @@ export namespace SubscriptionSchedulePlanChangeParams {
     }
   }
 
+  export interface OverrideGroupedWithProratedMinimumPrice {
+    id: string;
+
+    grouped_with_prorated_minimum_config: Record<string, unknown>;
+
+    model_type: 'grouped_with_prorated_minimum';
+
+    /**
+     * The per unit conversion rate of the price currency to the invoicing currency.
+     */
+    conversion_rate?: number | null;
+
+    /**
+     * The currency of the price. If not provided, the currency of the plan will be
+     * used.
+     */
+    currency?: string | null;
+
+    /**
+     * The subscription's override discount for the plan.
+     */
+    discount?: OverrideGroupedWithProratedMinimumPrice.Discount | null;
+
+    /**
+     * The starting quantity of the price, if the price is a fixed price.
+     */
+    fixed_price_quantity?: number | null;
+
+    /**
+     * The subscription's override maximum amount for the plan.
+     */
+    maximum_amount?: string | null;
+
+    /**
+     * The subscription's override minimum amount for the plan.
+     */
+    minimum_amount?: string | null;
+  }
+
+  export namespace OverrideGroupedWithProratedMinimumPrice {
+    /**
+     * The subscription's override discount for the plan.
+     */
+    export interface Discount {
+      discount_type: 'percentage' | 'trial' | 'usage' | 'amount';
+
+      /**
+       * Only available if discount_type is `amount`.
+       */
+      amount_discount?: string | null;
+
+      /**
+       * 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> | null;
+
+      /**
+       * Only available if discount_type is `percentage`. This is a number between 0
+       * and 1.
+       */
+      percentage_discount?: number | null;
+
+      /**
+       * Only available if discount_type is `trial`
+       */
+      trial_amount_discount?: string | null;
+
+      /**
+       * Only available if discount_type is `usage`. Number of usage units that this
+       * discount is for
+       */
+      usage_discount?: number | null;
+    }
+  }
+
   export interface OverrideBulkWithProrationPrice {
     id: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.13.0'; // x-release-please-version
+export const VERSION = '4.15.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.13.0";
+export declare const VERSION = "4.15.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.13.0'; // x-release-please-version
+exports.VERSION = '4.15.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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