stripe 22.6.0-alpha.2 → 22.6.0

package/esm/resources/V2/Billing/Intents.d.ts

@@ -1,1261 +0,0 @@
-import { StripeResource } from '../../../StripeResource.js';
-import { Decimal, OtherString, MetadataParam } from '../../../shared.js';
-import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
-import { ActionResource } from './Intents/Actions.js';
-import { Stripe } from '../../../stripe.core.js';
-export declare class IntentResource extends StripeResource {
-    private readonly stripe;
-    actions: ActionResource;
-    constructor(stripe: Stripe);
-    /**
-     * List Billing Intents.
-     */
-    list(params?: V2.Billing.IntentListParams, options?: RequestOptions): V2ListPromise<Intent>;
-    /**
-     * Create a Billing Intent.
-     */
-    create(params: V2.Billing.IntentCreateParams, options?: RequestOptions): Promise<Response<Intent>>;
-    /**
-     * Retrieve a Billing Intent.
-     */
-    retrieve(id: string, params?: V2.Billing.IntentRetrieveParams, options?: RequestOptions): Promise<Response<Intent>>;
-    /**
-     * Cancel a Billing Intent.
-     */
-    cancel(id: string, params?: V2.Billing.IntentCancelParams, options?: RequestOptions): Promise<Response<Intent>>;
-    /**
-     * Commit a Billing Intent.
-     */
-    commit(id: string, params?: V2.Billing.IntentCommitParams, options?: RequestOptions): Promise<Response<Intent>>;
-    /**
-     * Release a Billing Intent.
-     */
-    releaseReservation(id: string, params?: V2.Billing.IntentReleaseReservationParams, options?: RequestOptions): Promise<Response<Intent>>;
-    /**
-     * Reserve a Billing Intent.
-     */
-    reserve(id: string, params?: V2.Billing.IntentReserveParams, options?: RequestOptions): Promise<Response<Intent>>;
-}
-export interface Intent {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-    /**
-     * String representing the object's type. Objects of the same type share the same value of the object field.
-     */
-    object: 'v2.billing.intent';
-    /**
-     * Breakdown of the amount for this Billing Intent.
-     */
-    amount_details: Intent.AmountDetails;
-    /**
-     * ID of an existing Cadence to use.
-     */
-    cadence?: string;
-    /**
-     * Data for creating a new Cadence.
-     */
-    cadence_data?: Intent.CadenceData;
-    /**
-     * Time at which the object was created.
-     */
-    created: string;
-    /**
-     * Three-letter ISO currency code, in lowercase. Must be a supported currency.
-     */
-    currency: string;
-    /**
-     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-     */
-    livemode: boolean;
-    /**
-     * Current status of the Billing Intent.
-     */
-    status: Intent.Status;
-    /**
-     * Timestamps for status transitions of the Billing Intent.
-     */
-    status_transitions: Intent.StatusTransitions;
-}
-export declare namespace Intent {
-    interface AmountDetails {
-        /**
-         * The outstanding amount after discount, tax, and customer balance application.
-         */
-        amount_due: string;
-        /**
-         * Three-letter ISO currency code, in lowercase. Must be a supported currency.
-         */
-        currency: string;
-        /**
-         * The customer's account balance applied to the amount.
-         */
-        customer_balance_applied: string;
-        /**
-         * Amount of discount applied.
-         */
-        discount: string;
-        /**
-         * Amount of shipping charges.
-         */
-        shipping: string;
-        /**
-         * Subtotal amount before tax and discounts.
-         */
-        subtotal: string;
-        /**
-         * Amount of tax.
-         */
-        tax: string;
-        /**
-         * Total amount for the Billing Intent.
-         */
-        total: string;
-    }
-    interface CadenceData {
-        /**
-         * The billing cycle configuration for this Cadence.
-         */
-        billing_cycle: CadenceData.BillingCycle;
-        /**
-         * Information about the payer for this Cadence.
-         */
-        payer: CadenceData.Payer;
-        /**
-         * Settings for creating the Cadence.
-         */
-        settings?: CadenceData.Settings;
-    }
-    type Status = 'canceled' | 'committed' | 'draft' | 'reserved';
-    interface StatusTransitions {
-        /**
-         * Time at which the Billing Intent was canceled.
-         */
-        canceled_at?: string;
-        /**
-         * Time at which the Billing Intent was committed.
-         */
-        committed_at?: string;
-        /**
-         * Time at which the Billing Intent was drafted.
-         */
-        drafted_at?: string;
-        /**
-         * Time at which the Billing Intent expires.
-         */
-        expires_at: string;
-        /**
-         * Time at which the Billing Intent was reserved.
-         */
-        reserved_at?: string;
-    }
-    namespace CadenceData {
-        interface BillingCycle {
-            /**
-             * Specific configuration for determining billing dates when type=day.
-             */
-            day?: BillingCycle.Day;
-            /**
-             * The number of intervals (specified in the interval attribute) between cadence billings. For example, type=month and interval_count=3 bills every 3 months.
-             */
-            interval_count: number;
-            /**
-             * Specific configuration for determining billing dates when type=month.
-             */
-            month?: BillingCycle.Month;
-            /**
-             * The frequency at which a cadence bills.
-             */
-            type: BillingCycle.Type;
-            /**
-             * Specific configuration for determining billing dates when type=week.
-             */
-            week?: BillingCycle.Week;
-            /**
-             * Specific configuration for determining billing dates when type=year.
-             */
-            year?: BillingCycle.Year;
-        }
-        interface Payer {
-            /**
-             * The ID of the Billing Profile object which determines how a bill is paid.
-             */
-            billing_profile?: string;
-            /**
-             * Data for creating a new profile.
-             */
-            billing_profile_data?: Payer.BillingProfileData;
-        }
-        interface Settings {
-            /**
-             * Settings that configure bills generation, which includes calculating totals, tax, and presenting invoices.
-             */
-            bill?: Settings.Bill;
-            /**
-             * Settings that configure and manage the behavior of collecting payments.
-             */
-            collection?: Settings.Collection;
-        }
-        namespace BillingCycle {
-            interface Day {
-                /**
-                 * The time at which the billing cycle ends.
-                 */
-                time: Day.Time;
-            }
-            interface Month {
-                /**
-                 * The day to anchor the billing on for a type="month" billing cycle from 1-31.
-                 * If this number is greater than the number of days in the month being billed,
-                 * this anchors to the last day of the month.
-                 */
-                day_of_month: number;
-                /**
-                 * The month to anchor the billing on for a type="month" billing cycle from
-                 * 1-12. Occurrences are calculated from the month anchor.
-                 */
-                month_of_year?: number;
-                /**
-                 * The time at which the billing cycle ends.
-                 */
-                time: Month.Time;
-            }
-            type Type = 'day' | 'month' | 'week' | 'year' | OtherString;
-            interface Week {
-                /**
-                 * The day of the week to bill the type=week billing cycle on.
-                 * Numbered from 1-7 for Monday to Sunday respectively, based on the ISO-8601 week day numbering.
-                 */
-                day_of_week: number;
-                /**
-                 * The time at which the billing cycle ends.
-                 */
-                time: Week.Time;
-            }
-            interface Year {
-                /**
-                 * The day to anchor the billing on for a type="month" billing cycle from 1-31.
-                 * If this number is greater than the number of days in the month being billed,
-                 * this anchors to the last day of the month.
-                 */
-                day_of_month: number;
-                /**
-                 * The month to bill on from 1-12. If not provided, this defaults to the month the cadence was created.
-                 */
-                month_of_year: number;
-                /**
-                 * The time at which the billing cycle ends.
-                 */
-                time: Year.Time;
-            }
-            namespace Day {
-                interface Time {
-                    /**
-                     * The hour at which the billing cycle ends.
-                     * This must be an integer between 0 and 23, inclusive.
-                     * 0 represents midnight, and 23 represents 11 PM.
-                     */
-                    hour: number;
-                    /**
-                     * The minute at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    minute: number;
-                    /**
-                     * The second at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    second?: number;
-                }
-            }
-            namespace Month {
-                interface Time {
-                    /**
-                     * The hour at which the billing cycle ends.
-                     * This must be an integer between 0 and 23, inclusive.
-                     * 0 represents midnight, and 23 represents 11 PM.
-                     */
-                    hour: number;
-                    /**
-                     * The minute at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    minute: number;
-                    /**
-                     * The second at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    second?: number;
-                }
-            }
-            namespace Week {
-                interface Time {
-                    /**
-                     * The hour at which the billing cycle ends.
-                     * This must be an integer between 0 and 23, inclusive.
-                     * 0 represents midnight, and 23 represents 11 PM.
-                     */
-                    hour: number;
-                    /**
-                     * The minute at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    minute: number;
-                    /**
-                     * The second at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    second?: number;
-                }
-            }
-            namespace Year {
-                interface Time {
-                    /**
-                     * The hour at which the billing cycle ends.
-                     * This must be an integer between 0 and 23, inclusive.
-                     * 0 represents midnight, and 23 represents 11 PM.
-                     */
-                    hour: number;
-                    /**
-                     * The minute at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    minute: number;
-                    /**
-                     * The second at which the billing cycle ends.
-                     * Must be an integer between 0 and 59, inclusive.
-                     */
-                    second?: number;
-                }
-            }
-        }
-        namespace Payer {
-            interface BillingProfileData {
-                /**
-                 * The customer to associate with the profile.
-                 */
-                customer: string;
-                /**
-                 * The default payment method to use when billing this profile.
-                 * If none is provided, the customer `default_payment_method` is used.
-                 */
-                default_payment_method?: string;
-            }
-        }
-        namespace Settings {
-            interface Bill {
-                /**
-                 * The ID of the referenced settings object.
-                 */
-                id: string;
-                /**
-                 * Returns the Settings Version when the cadence is pinned to a specific version.
-                 */
-                version?: string;
-            }
-            interface Collection {
-                /**
-                 * The ID of the referenced settings object.
-                 */
-                id: string;
-                /**
-                 * Returns the Settings Version when the cadence is pinned to a specific version.
-                 */
-                version?: string;
-            }
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentCreateParams {
-            /**
-             * Actions to be performed by this Billing Intent.
-             */
-            actions: Array<IntentCreateParams.Action>;
-            /**
-             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
-             */
-            currency: string;
-            /**
-             * ID of an existing Cadence to use.
-             */
-            cadence?: string;
-            /**
-             * Data for creating a new Cadence.
-             */
-            cadence_data?: IntentCreateParams.CadenceData;
-        }
-        namespace IntentCreateParams {
-            interface Action {
-                /**
-                 * Details for an apply action.
-                 */
-                apply?: Action.Apply;
-                /**
-                 * Details for a deactivate action.
-                 */
-                deactivate?: Action.Deactivate;
-                /**
-                 * Details for a modify action.
-                 */
-                modify?: Action.Modify;
-                /**
-                 * Details for a remove action.
-                 */
-                remove?: Action.Remove;
-                /**
-                 * Details for a subscribe action.
-                 */
-                subscribe?: Action.Subscribe;
-                /**
-                 * Type of the Billing Intent action.
-                 */
-                type: Action.Type;
-            }
-            interface CadenceData {
-                /**
-                 * The billing cycle configuration for this Cadence.
-                 */
-                billing_cycle: CadenceData.BillingCycle;
-                /**
-                 * Information about the payer for this Cadence.
-                 */
-                payer: CadenceData.Payer;
-                /**
-                 * Settings for creating the Cadence.
-                 */
-                settings?: CadenceData.Settings;
-            }
-            namespace Action {
-                interface Apply {
-                    /**
-                     * Details for applying a discount.
-                     */
-                    discount?: Apply.Discount;
-                    /**
-                     * When the apply action takes effect. If not specified, defaults to on_reserve.
-                     */
-                    effective_at?: Apply.EffectiveAt;
-                    /**
-                     * Details for applying a discount rule to future invoices.
-                     */
-                    invoice_discount_rule?: Apply.InvoiceDiscountRule;
-                    /**
-                     * Details for applying a spend modifier rule. Only present if type is spend_modifier_rule.
-                     */
-                    spend_modifier_rule?: Apply.SpendModifierRule;
-                    /**
-                     * Type of the apply action details.
-                     */
-                    type: Apply.Type;
-                }
-                interface Deactivate {
-                    /**
-                     * Details about why the cancellation is being requested.
-                     */
-                    cancellation_details?: Deactivate.CancellationDetails;
-                    /**
-                     * When the invoice is collected. If not specified, the default behavior is on_effective_at.
-                     */
-                    collect_at?: Deactivate.CollectAt;
-                    /**
-                     * When the deactivate action takes effect. If not specified, the default behavior is on_reserve.
-                     */
-                    effective_at?: Deactivate.EffectiveAt;
-                    /**
-                     * Details for deactivating a pricing plan subscription.
-                     */
-                    pricing_plan_subscription_details: Deactivate.PricingPlanSubscriptionDetails;
-                    /**
-                     * Type of the action details.
-                     */
-                    type: Deactivate.Type;
-                }
-                interface Modify {
-                    /**
-                     * When the invoice is collected. If not specified, the default behavior is next_billing_date.
-                     */
-                    collect_at?: Modify.CollectAt;
-                    /**
-                     * When the modify action takes effect. If not specified, the default behavior is on_reserve.
-                     */
-                    effective_at?: Modify.EffectiveAt;
-                    /**
-                     * Details for modifying a pricing plan subscription.
-                     */
-                    pricing_plan_subscription_details: Modify.PricingPlanSubscriptionDetails;
-                    /**
-                     * Type of the action details.
-                     */
-                    type: Modify.Type;
-                }
-                interface Remove {
-                    /**
-                     * When the remove action takes effect. If not specified, defaults to on_reserve.
-                     */
-                    effective_at?: Remove.EffectiveAt;
-                    /**
-                     * The ID of the discount rule to remove for future invoices.
-                     */
-                    invoice_discount_rule?: string;
-                    /**
-                     * The ID of the spend modifier rule to remove.
-                     */
-                    spend_modifier_rule?: string;
-                    /**
-                     * Type of the remove action.
-                     */
-                    type: Remove.Type;
-                }
-                interface Subscribe {
-                    /**
-                     * When the invoice is collected. If not specified, defaults to on_effective_at.
-                     */
-                    collect_at?: Subscribe.CollectAt;
-                    /**
-                     * When the subscribe action takes effect. If not specified, the default behavior is on_reserve.
-                     */
-                    effective_at?: Subscribe.EffectiveAt;
-                    /**
-                     * Details for subscribing to a pricing plan.
-                     */
-                    pricing_plan_subscription_details?: Subscribe.PricingPlanSubscriptionDetails;
-                    /**
-                     * Type of the action details.
-                     */
-                    type: Subscribe.Type;
-                    /**
-                     * Details for subscribing to a v1 subscription.
-                     */
-                    v1_subscription_details?: Subscribe.V1SubscriptionDetails;
-                }
-                type Type = 'apply' | 'deactivate' | 'modify' | 'remove' | 'subscribe' | OtherString;
-                namespace Apply {
-                    interface Discount {
-                        /**
-                         * The ID of the Coupon to apply.
-                         */
-                        coupon?: string;
-                        /**
-                         * The ID of the PromotionCode to apply.
-                         */
-                        promotion_code?: string;
-                        /**
-                         * Type of the discount.
-                         */
-                        type: Discount.Type;
-                    }
-                    interface EffectiveAt {
-                        /**
-                         * The timestamp at which the apply action takes effect. Only present if type is timestamp. Only allowed for discount actions.
-                         */
-                        timestamp?: string;
-                        /**
-                         * When the apply action takes effect.
-                         */
-                        type: EffectiveAt.Type;
-                    }
-                    interface InvoiceDiscountRule {
-                        /**
-                         * The entity that the discount rule applies to, for example, the cadence.
-                         */
-                        applies_to: 'cadence';
-                        /**
-                         * Configuration for percentage off discount.
-                         */
-                        percent_off?: InvoiceDiscountRule.PercentOff;
-                        /**
-                         * Type of the discount rule.
-                         */
-                        type: 'percent_off';
-                    }
-                    interface SpendModifierRule {
-                        /**
-                         * What the spend modifier applies to.
-                         */
-                        applies_to: 'cadence';
-                        /**
-                         * Details for max billing period spend modifier. Only present if type is max_billing_period_spend.
-                         */
-                        max_billing_period_spend?: SpendModifierRule.MaxBillingPeriodSpend;
-                        /**
-                         * Type of the spend modifier.
-                         */
-                        type: 'max_billing_period_spend';
-                    }
-                    type Type = 'discount' | 'invoice_discount_rule' | 'spend_modifier_rule' | OtherString;
-                    namespace Discount {
-                        type Type = 'coupon' | 'promotion_code';
-                    }
-                    namespace EffectiveAt {
-                        type Type = 'current_billing_period_end' | 'current_billing_period_start' | 'next_billing_period_start' | 'on_reserve' | 'timestamp';
-                    }
-                    namespace InvoiceDiscountRule {
-                        interface PercentOff {
-                            /**
-                             * The maximum number of times this discount can be applied for this cadence.
-                             */
-                            maximum_applications: PercentOff.MaximumApplications;
-                            /**
-                             * Percent that is taken off the amount. For example, a percent_off of 50.0 reduces a 100 USD amount to 50 USD.
-                             */
-                            percent_off: Decimal;
-                        }
-                        namespace PercentOff {
-                            interface MaximumApplications {
-                                /**
-                                 * The type of maximum applications configuration.
-                                 */
-                                type: 'indefinite';
-                            }
-                        }
-                    }
-                    namespace SpendModifierRule {
-                        interface MaxBillingPeriodSpend {
-                            /**
-                             * The maximum amount allowed for the billing period.
-                             */
-                            amount: MaxBillingPeriodSpend.Amount;
-                            /**
-                             * The configuration for the overage rate for the custom pricing unit.
-                             */
-                            custom_pricing_unit_overage_rate: MaxBillingPeriodSpend.CustomPricingUnitOverageRate;
-                        }
-                        namespace MaxBillingPeriodSpend {
-                            interface Amount {
-                                /**
-                                 * The custom pricing unit amount.
-                                 */
-                                custom_pricing_unit?: Amount.CustomPricingUnit;
-                                /**
-                                 * The type of the amount.
-                                 */
-                                type: 'custom_pricing_unit';
-                            }
-                            interface CustomPricingUnitOverageRate {
-                                /**
-                                 * ID of the custom pricing unit overage rate.
-                                 */
-                                id: string;
-                            }
-                            namespace Amount {
-                                interface CustomPricingUnit {
-                                    /**
-                                     * The id of the custom pricing unit.
-                                     */
-                                    id?: string;
-                                    /**
-                                     * The value of the custom pricing unit.
-                                     */
-                                    value: string;
-                                }
-                            }
-                        }
-                    }
-                }
-                namespace Deactivate {
-                    interface CancellationDetails {
-                        /**
-                         * Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
-                         */
-                        comment?: string;
-                        /**
-                         * The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
-                         */
-                        feedback?: CancellationDetails.Feedback;
-                    }
-                    type CollectAt = 'next_billing_date' | 'on_effective_at' | OtherString;
-                    interface EffectiveAt {
-                        /**
-                         * The timestamp at which the deactivate action takes effect. Only present if type is timestamp.
-                         */
-                        timestamp?: string;
-                        /**
-                         * When the deactivate action takes effect.
-                         */
-                        type: EffectiveAt.Type;
-                    }
-                    interface PricingPlanSubscriptionDetails {
-                        /**
-                         * Configurations for overriding behaviors related to the subscription.
-                         */
-                        overrides?: PricingPlanSubscriptionDetails.Overrides;
-                        /**
-                         * ID of the pricing plan subscription to deactivate.
-                         */
-                        pricing_plan_subscription: string;
-                    }
-                    type Type = 'pricing_plan_subscription_details' | 'v1_subscription_details';
-                    namespace CancellationDetails {
-                        type Feedback = 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused' | OtherString;
-                    }
-                    namespace EffectiveAt {
-                        type Type = 'current_billing_period_end' | 'current_billing_period_start' | 'on_reserve' | 'timestamp' | OtherString;
-                    }
-                    namespace PricingPlanSubscriptionDetails {
-                        interface Overrides {
-                            /**
-                             * Configurations for behaviors when the action takes effect during the service period.
-                             */
-                            partial_period_behaviors: Array<Overrides.PartialPeriodBehavior>;
-                        }
-                        namespace Overrides {
-                            interface PartialPeriodBehavior {
-                                /**
-                                 * Overrides the behavior for license fee components when the action takes effect during the service period.
-                                 */
-                                license_fee?: PartialPeriodBehavior.LicenseFee;
-                                /**
-                                 * The type of behavior to override.
-                                 */
-                                type: PartialPeriodBehavior.Type;
-                            }
-                            namespace PartialPeriodBehavior {
-                                interface LicenseFee {
-                                    /**
-                                     * The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user is deactivating. If not specified, defaults to none.
-                                     */
-                                    credit_proration_behavior: LicenseFee.CreditProrationBehavior;
-                                }
-                                type Type = 'license_fee' | 'recurring_credit_grant' | OtherString;
-                                namespace LicenseFee {
-                                    type CreditProrationBehavior = 'none' | 'prorated' | OtherString;
-                                }
-                            }
-                        }
-                    }
-                }
-                namespace Modify {
-                    type CollectAt = 'next_billing_date' | 'on_effective_at' | OtherString;
-                    interface EffectiveAt {
-                        /**
-                         * The timestamp at which the modify action takes effect. Only present if type is timestamp.
-                         */
-                        timestamp?: string;
-                        /**
-                         * When the modify action takes effect.
-                         */
-                        type: EffectiveAt.Type;
-                    }
-                    interface PricingPlanSubscriptionDetails {
-                        /**
-                         * New configurations for the components of the pricing plan.
-                         */
-                        component_configurations?: Array<PricingPlanSubscriptionDetails.ComponentConfiguration>;
-                        /**
-                         * The ID of the new Pricing Plan, if changing plans.
-                         */
-                        new_pricing_plan?: string;
-                        /**
-                         * The ID of the new Pricing Plan Version to use.
-                         */
-                        new_pricing_plan_version?: string;
-                        /**
-                         * Configurations for overriding behaviors related to the subscription.
-                         */
-                        overrides?: PricingPlanSubscriptionDetails.Overrides;
-                        /**
-                         * The ID of the Pricing Plan Subscription to modify.
-                         */
-                        pricing_plan_subscription: string;
-                    }
-                    type Type = 'pricing_plan_subscription_details' | 'v1_subscription_details';
-                    namespace EffectiveAt {
-                        type Type = 'current_billing_period_start' | 'on_reserve' | 'timestamp' | OtherString;
-                    }
-                    namespace PricingPlanSubscriptionDetails {
-                        interface ComponentConfiguration {
-                            /**
-                             * Lookup key for the pricing plan component.
-                             */
-                            lookup_key?: string;
-                            /**
-                             * ID of the pricing plan component.
-                             */
-                            pricing_plan_component?: string;
-                            /**
-                             * Quantity of the component to be used.
-                             */
-                            quantity?: number;
-                        }
-                        interface Overrides {
-                            /**
-                             * Configurations for behaviors when the action takes effect during the service period.
-                             */
-                            partial_period_behaviors: Array<Overrides.PartialPeriodBehavior>;
-                        }
-                        namespace Overrides {
-                            interface PartialPeriodBehavior {
-                                /**
-                                 * Overrides the behavior for license fee components when the action takes effect during the service period.
-                                 */
-                                license_fee?: PartialPeriodBehavior.LicenseFee;
-                                /**
-                                 * Overrides the behavior for recurring credit grant components when the action takes effect during the service period.
-                                 */
-                                recurring_credit_grant?: PartialPeriodBehavior.RecurringCreditGrant;
-                                /**
-                                 * The type of behavior to override.
-                                 */
-                                type: PartialPeriodBehavior.Type;
-                            }
-                            namespace PartialPeriodBehavior {
-                                interface LicenseFee {
-                                    /**
-                                     * The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user modifies the subscription. If not specified, defaults to prorated.
-                                     */
-                                    credit_proration_behavior: LicenseFee.CreditProrationBehavior;
-                                    /**
-                                     * The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user modifies the subscription. If not specified, defaults to prorated.
-                                     */
-                                    debit_proration_behavior: LicenseFee.DebitProrationBehavior;
-                                }
-                                interface RecurringCreditGrant {
-                                    /**
-                                     * Controls credit grant creation behavior during partial periods. If not specified, defaults to full_credits.
-                                     */
-                                    create_behavior: RecurringCreditGrant.CreateBehavior;
-                                }
-                                type Type = 'license_fee' | 'recurring_credit_grant' | OtherString;
-                                namespace LicenseFee {
-                                    type CreditProrationBehavior = 'none' | 'prorated' | OtherString;
-                                    type DebitProrationBehavior = 'none' | 'prorated' | OtherString;
-                                }
-                                namespace RecurringCreditGrant {
-                                    type CreateBehavior = 'full_credits' | 'none' | OtherString;
-                                }
-                            }
-                        }
-                    }
-                }
-                namespace Remove {
-                    interface EffectiveAt {
-                        /**
-                         * When the remove action takes effect.
-                         */
-                        type: EffectiveAt.Type;
-                    }
-                    type Type = 'invoice_discount_rule' | 'spend_modifier_rule' | OtherString;
-                    namespace EffectiveAt {
-                        type Type = 'current_billing_period_end' | 'on_reserve' | OtherString;
-                    }
-                }
-                namespace Subscribe {
-                    type CollectAt = 'next_billing_date' | 'on_effective_at' | OtherString;
-                    interface EffectiveAt {
-                        /**
-                         * The timestamp at which the subscribe action takes effect. Only present if type is timestamp.
-                         */
-                        timestamp?: string;
-                        /**
-                         * When the subscribe action takes effect.
-                         */
-                        type: EffectiveAt.Type;
-                    }
-                    interface PricingPlanSubscriptionDetails {
-                        /**
-                         * Configurations for the components of the pricing plan.
-                         */
-                        component_configurations?: Array<PricingPlanSubscriptionDetails.ComponentConfiguration>;
-                        /**
-                         * Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-                         */
-                        metadata?: MetadataParam;
-                        /**
-                         * Configurations for overriding behaviors related to the subscription.
-                         */
-                        overrides?: PricingPlanSubscriptionDetails.Overrides;
-                        /**
-                         * ID of the Pricing Plan to subscribe to.
-                         */
-                        pricing_plan: string;
-                        /**
-                         * Version of the Pricing Plan to use.
-                         */
-                        pricing_plan_version: string;
-                    }
-                    type Type = 'pricing_plan_subscription_details' | 'v1_subscription_details';
-                    interface V1SubscriptionDetails {
-                        /**
-                         * The subscription's description, meant to be displayable to the customer.
-                         * Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
-                         */
-                        description?: string;
-                        /**
-                         * A list of up to 20 subscription items, each with an attached price.
-                         */
-                        items: Array<V1SubscriptionDetails.Item>;
-                        /**
-                         * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-                         */
-                        metadata?: MetadataParam;
-                    }
-                    namespace EffectiveAt {
-                        type Type = 'current_billing_period_start' | 'on_reserve' | 'timestamp' | OtherString;
-                    }
-                    namespace PricingPlanSubscriptionDetails {
-                        interface ComponentConfiguration {
-                            /**
-                             * Lookup key for the pricing plan component.
-                             */
-                            lookup_key?: string;
-                            /**
-                             * ID of the pricing plan component.
-                             */
-                            pricing_plan_component?: string;
-                            /**
-                             * Quantity of the component to be used.
-                             */
-                            quantity?: number;
-                        }
-                        interface Overrides {
-                            /**
-                             * Configurations for behaviors when the action takes effect during the service period.
-                             */
-                            partial_period_behaviors: Array<Overrides.PartialPeriodBehavior>;
-                        }
-                        namespace Overrides {
-                            interface PartialPeriodBehavior {
-                                /**
-                                 * Overrides the behavior for license fee components when the action takes effect during the service period.
-                                 */
-                                license_fee?: PartialPeriodBehavior.LicenseFee;
-                                /**
-                                 * Overrides the behavior for recurring credit grant components when the action takes effect during the service period.
-                                 */
-                                recurring_credit_grant?: PartialPeriodBehavior.RecurringCreditGrant;
-                                /**
-                                 * The type of behavior to override.
-                                 */
-                                type: PartialPeriodBehavior.Type;
-                            }
-                            namespace PartialPeriodBehavior {
-                                interface LicenseFee {
-                                    /**
-                                     * The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user is subscribing. If not specified, defaults to prorated.
-                                     */
-                                    debit_proration_behavior: LicenseFee.DebitProrationBehavior;
-                                }
-                                interface RecurringCreditGrant {
-                                    /**
-                                     * Controls credit grant creation behavior during partial periods. If not specified, defaults to full_credits.
-                                     */
-                                    create_behavior: RecurringCreditGrant.CreateBehavior;
-                                }
-                                type Type = 'license_fee' | 'recurring_credit_grant' | OtherString;
-                                namespace LicenseFee {
-                                    type DebitProrationBehavior = 'none' | 'prorated' | OtherString;
-                                }
-                                namespace RecurringCreditGrant {
-                                    type CreateBehavior = 'full_credits' | 'none' | OtherString;
-                                }
-                            }
-                        }
-                    }
-                    namespace V1SubscriptionDetails {
-                        interface Item {
-                            /**
-                             * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-                             */
-                            metadata?: MetadataParam;
-                            /**
-                             * The ID of the price object.
-                             */
-                            price: string;
-                            /**
-                             * Quantity for this item. If not provided, defaults to 1.
-                             */
-                            quantity?: number;
-                        }
-                    }
-                }
-            }
-            namespace CadenceData {
-                interface BillingCycle {
-                    /**
-                     * Specific configuration for determining billing dates when type=day.
-                     */
-                    day?: BillingCycle.Day;
-                    /**
-                     * The number of intervals (specified in the interval attribute) between
-                     * cadence billings. For example, type=month and interval_count=3 bills every
-                     * 3 months. If not provided, this defaults to 1.
-                     */
-                    interval_count?: number;
-                    /**
-                     * Specific configuration for determining billing dates when type=month.
-                     */
-                    month?: BillingCycle.Month;
-                    /**
-                     * The frequency at which a cadence bills.
-                     */
-                    type: BillingCycle.Type;
-                    /**
-                     * Specific configuration for determining billing dates when type=week.
-                     */
-                    week?: BillingCycle.Week;
-                    /**
-                     * Specific configuration for determining billing dates when type=year.
-                     */
-                    year?: BillingCycle.Year;
-                }
-                interface Payer {
-                    /**
-                     * The ID of the Billing Profile object which determines how a bill is paid.
-                     */
-                    billing_profile?: string;
-                    /**
-                     * Data for creating a new profile.
-                     */
-                    billing_profile_data?: Payer.BillingProfileData;
-                }
-                interface Settings {
-                    /**
-                     * Settings that configure bill generation, which includes calculating totals, tax, and presenting invoices.
-                     * If no setting is provided here, the settings from the customer referenced on the payer will be used.
-                     * If no customer settings are present, the merchant default settings will be used.
-                     */
-                    bill?: Settings.Bill;
-                    /**
-                     * Settings that configure and manage the behavior of collecting payments.
-                     * If no setting is provided here, the settings from the customer referenced from the payer will be used if they exist.
-                     * If no customer settings are present, the merchant default settings will be used.
-                     */
-                    collection?: Settings.Collection;
-                }
-                namespace BillingCycle {
-                    interface Day {
-                        /**
-                         * The time at which the billing cycle ends.
-                         * This field is optional, and if not provided, it defaults to
-                         * the time at which the cadence was created in UTC timezone.
-                         */
-                        time?: Day.Time;
-                    }
-                    interface Month {
-                        /**
-                         * The day to anchor the billing on for a type="month" billing cycle from
-                         * 1-31. If this number is greater than the number of days in the month being
-                         * billed, this anchors to the last day of the month. If not provided,
-                         * this defaults to the day the cadence was created.
-                         */
-                        day_of_month: number;
-                        /**
-                         * The month to anchor the billing on for a type="month" billing cycle from
-                         * 1-12. If not provided, this defaults to the month the cadence was created.
-                         * This setting can only be used for monthly billing cycles with `interval_count` of 2, 3, 4 or 6.
-                         * All occurrences are calculated from the month provided.
-                         */
-                        month_of_year?: number;
-                        /**
-                         * The time at which the billing cycle ends.
-                         * This field is optional, and if not provided, it defaults to
-                         * the time at which the cadence was created in UTC timezone.
-                         */
-                        time?: Month.Time;
-                    }
-                    type Type = 'day' | 'month' | 'week' | 'year' | OtherString;
-                    interface Week {
-                        /**
-                         * The day of the week to bill the type=week billing cycle on.
-                         * Numbered from 1-7 for Monday to Sunday respectively, based on the ISO-8601
-                         * week day numbering. If not provided, this defaults to the day the
-                         * cadence was created.
-                         */
-                        day_of_week: number;
-                        /**
-                         * The time at which the billing cycle ends.
-                         * This field is optional, and if not provided, it defaults to
-                         * the time at which the cadence was created in UTC timezone.
-                         */
-                        time?: Week.Time;
-                    }
-                    interface Year {
-                        /**
-                         * The day to anchor the billing on for a type="month" billing cycle from
-                         * 1-31. If this number is greater than the number of days in the month being
-                         * billed, this anchors to the last day of the month. If not provided,
-                         * this defaults to the day the cadence was created.
-                         */
-                        day_of_month?: number;
-                        /**
-                         * The month to bill on from 1-12. If not provided, this defaults to the
-                         * month the cadence was created.
-                         */
-                        month_of_year?: number;
-                        /**
-                         * The time at which the billing cycle ends.
-                         * This field is optional, and if not provided, it defaults to
-                         * the time at which the cadence was created in UTC timezone.
-                         */
-                        time?: Year.Time;
-                    }
-                    namespace Day {
-                        interface Time {
-                            /**
-                             * The hour at which the billing cycle ends.
-                             * This must be an integer between 0 and 23, inclusive.
-                             * 0 represents midnight, and 23 represents 11 PM.
-                             */
-                            hour: number;
-                            /**
-                             * The minute at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            minute: number;
-                            /**
-                             * The second at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            second: number;
-                        }
-                    }
-                    namespace Month {
-                        interface Time {
-                            /**
-                             * The hour at which the billing cycle ends.
-                             * This must be an integer between 0 and 23, inclusive.
-                             * 0 represents midnight, and 23 represents 11 PM.
-                             */
-                            hour: number;
-                            /**
-                             * The minute at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            minute: number;
-                            /**
-                             * The second at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            second: number;
-                        }
-                    }
-                    namespace Week {
-                        interface Time {
-                            /**
-                             * The hour at which the billing cycle ends.
-                             * This must be an integer between 0 and 23, inclusive.
-                             * 0 represents midnight, and 23 represents 11 PM.
-                             */
-                            hour: number;
-                            /**
-                             * The minute at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            minute: number;
-                            /**
-                             * The second at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            second: number;
-                        }
-                    }
-                    namespace Year {
-                        interface Time {
-                            /**
-                             * The hour at which the billing cycle ends.
-                             * This must be an integer between 0 and 23, inclusive.
-                             * 0 represents midnight, and 23 represents 11 PM.
-                             */
-                            hour: number;
-                            /**
-                             * The minute at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            minute: number;
-                            /**
-                             * The second at which the billing cycle ends.
-                             * Must be an integer between 0 and 59, inclusive.
-                             */
-                            second: number;
-                        }
-                    }
-                }
-                namespace Payer {
-                    interface BillingProfileData {
-                        /**
-                         * The customer to associate with the profile.
-                         */
-                        customer: string;
-                        /**
-                         * The default payment method to use when billing this profile.
-                         * If left blank, the `PaymentMethod` from the `PaymentIntent` provided
-                         * on commit is used to create the profile.
-                         */
-                        default_payment_method?: string;
-                    }
-                }
-                namespace Settings {
-                    interface Bill {
-                        /**
-                         * The ID of the referenced settings object.
-                         */
-                        id: string;
-                        /**
-                         * An optional field to specify the version of the Settings to use.
-                         * If not provided, this defaults to the live version any time the settings are used.
-                         */
-                        version?: string;
-                    }
-                    interface Collection {
-                        /**
-                         * The ID of the referenced settings object.
-                         */
-                        id: string;
-                        /**
-                         * An optional field to specify the version of the Settings to use.
-                         * If not provided, this defaults to the live version any time the settings are used.
-                         */
-                        version?: string;
-                    }
-                }
-            }
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentRetrieveParams {
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentListParams {
-            /**
-             * Optionally set the maximum number of results per page. Defaults to 10.
-             */
-            limit?: number;
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentCancelParams {
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentCommitParams {
-            /**
-             * ID of the PaymentIntent associated with this commit.
-             */
-            payment_intent?: string;
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentReleaseReservationParams {
-        }
-    }
-}
-export declare namespace V2 {
-    namespace Billing {
-        interface IntentReserveParams {
-        }
-    }
-}