orb-billing 4.13.0 → 4.15.0

package/resources/subscriptions.d.ts

@@ -1898,12 +1898,26 @@ export declare 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;
     external_customer_id?: string | null;
@@ -1914,7 +1928,15 @@ export interface SubscriptionCreateParams {
      * to. Note that either this property or `plan_id` must be specified.
      */
     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;
     /**
      * User-specified key/value pairs for the resource. Individual keys can be removed
@@ -1922,6 +1944,11 @@ export interface SubscriptionCreateParams {
      * by setting `metadata` to `null`.
      */
     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;
     /**
@@ -1932,7 +1959,7 @@ export interface SubscriptionCreateParams {
     /**
      * Optionally provide a list of overrides for prices on the plan
      */
-    price_overrides?: Array<SubscriptionCreateParams.OverrideUnitPrice | SubscriptionCreateParams.OverridePackagePrice | SubscriptionCreateParams.OverrideMatrixPrice | SubscriptionCreateParams.OverrideTieredPrice | SubscriptionCreateParams.OverrideTieredBpsPrice | SubscriptionCreateParams.OverrideBpsPrice | SubscriptionCreateParams.OverrideBulkBpsPrice | SubscriptionCreateParams.OverrideBulkPrice | SubscriptionCreateParams.OverrideThresholdTotalAmountPrice | SubscriptionCreateParams.OverrideTieredPackagePrice | SubscriptionCreateParams.OverrideTieredWithMinimumPrice | SubscriptionCreateParams.OverridePackageWithAllocationPrice | SubscriptionCreateParams.OverrideUnitWithPercentPrice | SubscriptionCreateParams.OverrideGroupedAllocationPrice | SubscriptionCreateParams.OverrideBulkWithProrationPrice> | null;
+    price_overrides?: Array<SubscriptionCreateParams.OverrideUnitPrice | SubscriptionCreateParams.OverridePackagePrice | SubscriptionCreateParams.OverrideMatrixPrice | SubscriptionCreateParams.OverrideTieredPrice | SubscriptionCreateParams.OverrideTieredBpsPrice | SubscriptionCreateParams.OverrideBpsPrice | SubscriptionCreateParams.OverrideBulkBpsPrice | SubscriptionCreateParams.OverrideBulkPrice | SubscriptionCreateParams.OverrideThresholdTotalAmountPrice | SubscriptionCreateParams.OverrideTieredPackagePrice | SubscriptionCreateParams.OverrideTieredWithMinimumPrice | SubscriptionCreateParams.OverridePackageWithAllocationPrice | SubscriptionCreateParams.OverrideUnitWithPercentPrice | SubscriptionCreateParams.OverrideGroupedAllocationPrice | SubscriptionCreateParams.OverrideGroupedWithProratedMinimumPrice | SubscriptionCreateParams.OverrideBulkWithProrationPrice> | null;
     start_date?: string | null;
 }
 export declare namespace SubscriptionCreateParams {
@@ -2955,6 +2982,67 @@ export declare namespace SubscriptionCreateParams {
             usage_discount?: number | null;
         }
     }
+    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;
+    }
+    namespace OverrideGroupedWithProratedMinimumPrice {
+        /**
+         * The subscription's override discount for the plan.
+         */
+        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;
+        }
+    }
     interface OverrideBulkWithProrationPrice {
         id: string;
         bulk_with_proration_config: Record<string, unknown>;
@@ -3190,7 +3278,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.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingBulkWithProrationPrice | 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.NewFloatingTieredWithMinimumPrice | Add.NewFloatingPackageWithAllocationPrice | Add.NewFloatingTieredPackageWithMinimumPrice | Add.NewFloatingUnitWithPercentPrice | Add.NewFloatingTieredWithProrationPrice | Add.NewFloatingUnitWithProrationPrice | Add.NewFloatingGroupedAllocationPrice | Add.NewFloatingGroupedWithProratedMinimumPrice | Add.NewFloatingBulkWithProrationPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -5197,6 +5285,99 @@ export declare namespace SubscriptionPriceIntervalsParams {
                 duration_unit: 'day' | 'month';
             }
         }
+        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;
+        }
+        namespace NewFloatingGroupedWithProratedMinimumPrice {
+            /**
+             * 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 NewFloatingBulkWithProrationPrice {
             bulk_with_proration_config: Record<string, unknown>;
             /**
@@ -5409,6 +5590,12 @@ export interface SubscriptionSchedulePlanChangeParams {
      * aligned with the plan change's effective date.
      */
     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
@@ -5423,10 +5610,15 @@ 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.
@@ -5442,6 +5634,12 @@ export interface SubscriptionSchedulePlanChangeParams {
      * at the end of the billing period.
      */
     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;
     /**
      * The plan that the given subscription should be switched to. Note that either
@@ -5451,7 +5649,7 @@ export interface SubscriptionSchedulePlanChangeParams {
     /**
      * Optionally provide a list of overrides for prices on the plan
      */
-    price_overrides?: Array<SubscriptionSchedulePlanChangeParams.OverrideUnitPrice | SubscriptionSchedulePlanChangeParams.OverridePackagePrice | SubscriptionSchedulePlanChangeParams.OverrideMatrixPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkPrice | SubscriptionSchedulePlanChangeParams.OverrideThresholdTotalAmountPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPackagePrice | SubscriptionSchedulePlanChangeParams.OverrideTieredWithMinimumPrice | SubscriptionSchedulePlanChangeParams.OverridePackageWithAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideUnitWithPercentPrice | SubscriptionSchedulePlanChangeParams.OverrideGroupedAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkWithProrationPrice> | null;
+    price_overrides?: Array<SubscriptionSchedulePlanChangeParams.OverrideUnitPrice | SubscriptionSchedulePlanChangeParams.OverridePackagePrice | SubscriptionSchedulePlanChangeParams.OverrideMatrixPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkBpsPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkPrice | SubscriptionSchedulePlanChangeParams.OverrideThresholdTotalAmountPrice | SubscriptionSchedulePlanChangeParams.OverrideTieredPackagePrice | SubscriptionSchedulePlanChangeParams.OverrideTieredWithMinimumPrice | SubscriptionSchedulePlanChangeParams.OverridePackageWithAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideUnitWithPercentPrice | SubscriptionSchedulePlanChangeParams.OverrideGroupedAllocationPrice | SubscriptionSchedulePlanChangeParams.OverrideGroupedWithProratedMinimumPrice | SubscriptionSchedulePlanChangeParams.OverrideBulkWithProrationPrice> | null;
 }
 export declare namespace SubscriptionSchedulePlanChangeParams {
     interface OverrideUnitPrice {
@@ -6453,6 +6651,67 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             usage_discount?: number | null;
         }
     }
+    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;
+    }
+    namespace OverrideGroupedWithProratedMinimumPrice {
+        /**
+         * The subscription's override discount for the plan.
+         */
+        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;
+        }
+    }
     interface OverrideBulkWithProrationPrice {
         id: string;
         bulk_with_proration_config: Record<string, unknown>;