stripe 19.4.0-alpha.2 → 20.1.0-alpha.1

package/types/Radar/AccountEvaluations.d.ts

@@ -0,0 +1,88 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      /**
+       * Account Evaluation resource returned by the Radar Account Evaluations API.
+       */
+      interface AccountEvaluation {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'radar.account_evaluation';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created_at: number;
+
+        /**
+         * The ID of the Stripe customer the account evaluation is associated with.
+         */
+        customer: string;
+
+        /**
+         * The list of events that were reported for this Account Evaluation object via the report API.
+         */
+        events: Array<AccountEvaluation.Event> | null;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * A hash of signal objects providing Radar's evaluation for the lifecycle event.
+         */
+        signals: AccountEvaluation.Signals | null;
+
+        /**
+         * The type of evaluation returned, based on the user's request.
+         */
+        type: string;
+      }
+
+      namespace AccountEvaluation {
+        interface Event {
+          /**
+           * Time at which the event occurred. Measured in seconds since the Unix epoch.
+           */
+          occurred_at: number;
+
+          /**
+           * The type of event that occurred.
+           */
+          type: string;
+        }
+
+        interface Signals {
+          account_sharing?: Signals.AccountSharing;
+
+          multi_accounting?: Signals.MultiAccounting;
+        }
+
+        namespace Signals {
+          interface AccountSharing {
+            /**
+             * Score for this signal (float between 0.0-100.0).
+             */
+            score: number;
+          }
+
+          interface MultiAccounting {
+            /**
+             * Score for this signal (float between 0.0-100.0).
+             */
+            score: number;
+          }
+        }
+      }
+    }
+  }
+}

package/types/Radar/AccountEvaluationsResource.d.ts

@@ -0,0 +1,148 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Radar {
+      interface AccountEvaluationCreateParams {
+        /**
+         * The type of evaluation requested.
+         */
+        type: AccountEvaluationCreateParams.Type;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Event payload for login_initiated.
+         */
+        login_initiated?: AccountEvaluationCreateParams.LoginInitiated;
+
+        /**
+         * Event payload for registration_initiated.
+         */
+        registration_initiated?: AccountEvaluationCreateParams.RegistrationInitiated;
+      }
+
+      namespace AccountEvaluationCreateParams {
+        interface LoginInitiated {
+          /**
+           * Client device metadata details (e.g., radar_session).
+           */
+          client_device_metadata_details: LoginInitiated.ClientDeviceMetadataDetails;
+
+          /**
+           * Stripe customer ID
+           */
+          customer: string;
+        }
+
+        namespace LoginInitiated {
+          interface ClientDeviceMetadataDetails {
+            /**
+             * ID for the Radar Session associated with the account evaluation.
+             */
+            radar_session: string;
+          }
+        }
+
+        interface RegistrationInitiated {
+          /**
+           * Client device metadata details (e.g., radar_session).
+           */
+          client_device_metadata_details: RegistrationInitiated.ClientDeviceMetadataDetails;
+
+          /**
+           * Stripe customer ID
+           */
+          customer?: string;
+
+          /**
+           * Customer data
+           */
+          customer_data?: RegistrationInitiated.CustomerData;
+        }
+
+        namespace RegistrationInitiated {
+          interface ClientDeviceMetadataDetails {
+            /**
+             * ID for the Radar Session associated with the account evaluation.
+             */
+            radar_session: string;
+          }
+
+          interface CustomerData {
+            /**
+             * Customer email
+             */
+            email?: string;
+
+            /**
+             * Customer name
+             */
+            name?: string;
+
+            /**
+             * Customer phone
+             */
+            phone?: string;
+          }
+        }
+
+        type Type = 'login_initiated' | 'registration_initiated';
+      }
+
+      interface AccountEvaluationRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AccountEvaluationUpdateParams {
+        /**
+         * The type of event to report.
+         */
+        type: 'registration_succeeded';
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class AccountEvaluationsResource {
+        /**
+         * Creates a new AccountEvaluation object.
+         */
+        create(
+          params: AccountEvaluationCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.AccountEvaluation>>;
+
+        /**
+         * Retrieves an AccountEvaluation object.
+         */
+        retrieve(
+          id: string,
+          params?: AccountEvaluationRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.AccountEvaluation>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.AccountEvaluation>>;
+
+        /**
+         * Reports an event on an AccountEvaluation object.
+         */
+        update(
+          id: string,
+          params: AccountEvaluationUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Radar.AccountEvaluation>>;
+      }
+    }
+  }
+}

package/types/Refunds.d.ts

@@ -154,6 +154,8 @@ declare module 'stripe' {
 
         klarna?: DestinationDetails.Klarna;
 
+        mb_way?: DestinationDetails.MbWay;
+
         multibanco?: DestinationDetails.Multibanco;
 
         mx_bank_transfer?: DestinationDetails.MxBankTransfer;
@@ -176,6 +178,8 @@ declare module 'stripe' {
 
         th_bank_transfer?: DestinationDetails.ThBankTransfer;
 
+        twint?: DestinationDetails.Twint;
+
         /**
          * The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.
          */
@@ -323,6 +327,18 @@ declare module 'stripe' {
 
         interface Klarna {}
 
+        interface MbWay {
+          /**
+           * The reference assigned to the refund.
+           */
+          reference: string | null;
+
+          /**
+           * Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.
+           */
+          reference_status: string | null;
+        }
+
         interface Multibanco {
           /**
            * The reference assigned to the refund.
@@ -405,6 +421,8 @@ declare module 'stripe' {
           reference_status: string | null;
         }
 
+        interface Twint {}
+
         interface UsBankTransfer {
           /**
            * The reference assigned to the refund.

package/types/SetupAttempts.d.ts

@@ -439,7 +439,7 @@ declare module 'stripe' {
 
         interface Ideal {
           /**
-           * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+           * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
            */
           bank: Ideal.Bank | null;
 
@@ -476,6 +476,7 @@ declare module 'stripe' {
             | 'asn_bank'
             | 'bunq'
             | 'buut'
+            | 'finom'
             | 'handelsbanken'
             | 'ing'
             | 'knab'
@@ -496,6 +497,7 @@ declare module 'stripe' {
             | 'BITSNL2A'
             | 'BUNQNL2A'
             | 'BUUTNL2A'
+            | 'FNOMNL22'
             | 'FVLBNL22'
             | 'HANDNL2A'
             | 'INGBNL2A'

package/types/SetupIntents.d.ts

@@ -944,7 +944,7 @@ declare module 'stripe' {
             amount: number | null;
 
             /**
-             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
              */
             amount_type: MandateOptions.AmountType | null;
 
@@ -954,7 +954,7 @@ declare module 'stripe' {
             end_date: string | null;
 
             /**
-             * The periodicity at which payments will be collected.
+             * The periodicity at which payments will be collected. Defaults to `adhoc`.
              */
             payment_schedule: MandateOptions.PaymentSchedule | null;
 
@@ -964,7 +964,7 @@ declare module 'stripe' {
             payments_per_period: number | null;
 
             /**
-             * The purpose for which payments are made. Defaults to retail.
+             * The purpose for which payments are made. Has a default value based on your merchant category code.
              */
             purpose: MandateOptions.Purpose | null;
 

package/types/SetupIntentsResource.d.ts

@@ -783,6 +783,7 @@ declare module 'stripe' {
             | 'asn_bank'
             | 'bunq'
             | 'buut'
+            | 'finom'
             | 'handelsbanken'
             | 'ing'
             | 'knab'
@@ -1649,7 +1650,7 @@ declare module 'stripe' {
             amount?: number;
 
             /**
-             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
              */
             amount_type?: MandateOptions.AmountType;
 
@@ -1659,7 +1660,7 @@ declare module 'stripe' {
             end_date?: string;
 
             /**
-             * The periodicity at which payments will be collected.
+             * The periodicity at which payments will be collected. Defaults to `adhoc`.
              */
             payment_schedule?: MandateOptions.PaymentSchedule;
 
@@ -1669,7 +1670,7 @@ declare module 'stripe' {
             payments_per_period?: number;
 
             /**
-             * The purpose for which payments are made. Defaults to retail.
+             * The purpose for which payments are made. Has a default value based on your merchant category code.
              */
             purpose?: MandateOptions.Purpose;
 
@@ -2617,6 +2618,7 @@ declare module 'stripe' {
             | 'asn_bank'
             | 'bunq'
             | 'buut'
+            | 'finom'
             | 'handelsbanken'
             | 'ing'
             | 'knab'
@@ -3483,7 +3485,7 @@ declare module 'stripe' {
             amount?: number;
 
             /**
-             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
              */
             amount_type?: MandateOptions.AmountType;
 
@@ -3493,7 +3495,7 @@ declare module 'stripe' {
             end_date?: string;
 
             /**
-             * The periodicity at which payments will be collected.
+             * The periodicity at which payments will be collected. Defaults to `adhoc`.
              */
             payment_schedule?: MandateOptions.PaymentSchedule;
 
@@ -3503,7 +3505,7 @@ declare module 'stripe' {
             payments_per_period?: number;
 
             /**
-             * The purpose for which payments are made. Defaults to retail.
+             * The purpose for which payments are made. Has a default value based on your merchant category code.
              */
             purpose?: MandateOptions.Purpose;
 
@@ -4433,6 +4435,7 @@ declare module 'stripe' {
             | 'asn_bank'
             | 'bunq'
             | 'buut'
+            | 'finom'
             | 'handelsbanken'
             | 'ing'
             | 'knab'
@@ -5299,7 +5302,7 @@ declare module 'stripe' {
             amount?: number;
 
             /**
-             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+             * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
              */
             amount_type?: MandateOptions.AmountType;
 
@@ -5309,7 +5312,7 @@ declare module 'stripe' {
             end_date?: string;
 
             /**
-             * The periodicity at which payments will be collected.
+             * The periodicity at which payments will be collected. Defaults to `adhoc`.
              */
             payment_schedule?: MandateOptions.PaymentSchedule;
 
@@ -5319,7 +5322,7 @@ declare module 'stripe' {
             payments_per_period?: number;
 
             /**
-             * The purpose for which payments are made. Defaults to retail.
+             * The purpose for which payments are made. Has a default value based on your merchant category code.
              */
             purpose?: MandateOptions.Purpose;
 

package/types/SubscriptionSchedules.d.ts

@@ -177,19 +177,19 @@ declare module 'stripe' {
         applies_to: Array<BillingSchedule.AppliesTo> | null;
 
         /**
-         * Specifies the billing period.
+         * Specifies the start of the billing period.
          */
-        bill_until: BillingSchedule.BillUntil;
+        bill_from?: BillingSchedule.BillFrom | null;
 
         /**
-         * Unique identifier for the billing schedule.
+         * Specifies the end of billing period.
          */
-        key: string;
+        bill_until: BillingSchedule.BillUntil;
 
         /**
-         * Specifies the start of the billing period.
+         * Unique identifier for the billing schedule.
          */
-        bill_from?: BillingSchedule.BillFrom | null;
+        key: string;
       }
 
       namespace BillingSchedule {
@@ -279,6 +279,11 @@ declare module 'stripe' {
         }
 
         interface BillUntil {
+          /**
+           * Use an index to specify the position of an amendment to end prebilling with.
+           */
+          amendment_end?: BillUntil.AmendmentEnd | null;
+
           /**
            * The timestamp the billing schedule will apply until.
            */
@@ -289,6 +294,11 @@ declare module 'stripe' {
            */
           duration: BillUntil.Duration | null;
 
+          /**
+           * Lets you bill the period ending at a particular Quote line.
+           */
+          line_ends_at?: BillUntil.LineEndsAt | null;
+
           /**
            * If specified, the billing schedule will apply until the specified timestamp.
            */
@@ -298,16 +308,6 @@ declare module 'stripe' {
            * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
            */
           type: BillUntil.Type;
-
-          /**
-           * Use an index to specify the position of an amendment to end prebilling with.
-           */
-          amendment_end?: BillUntil.AmendmentEnd | null;
-
-          /**
-           * Lets you bill the period ending at a particular Quote line.
-           */
-          line_ends_at?: BillUntil.LineEndsAt | null;
         }
 
         namespace BillUntil {

package/types/SubscriptionSchedulesResource.d.ts

@@ -1060,8 +1060,8 @@ declare module 'stripe' {
       /**
        * Sets the billing schedules for the subscription schedule.
        */
-      billing_schedules?: Array<
-        SubscriptionScheduleUpdateParams.BillingSchedule
+      billing_schedules?: Stripe.Emptyable<
+        Array<SubscriptionScheduleUpdateParams.BillingSchedule>
       >;
 
       /**
@@ -2176,6 +2176,11 @@ declare module 'stripe' {
          * Settings related to subscription trials.
          */
         trial_settings?: Amendment.TrialSettings;
+
+        /**
+         * Actions to apply to the billing schedules.
+         */
+        billing_schedules_actions?: Array<Amendment.BillingSchedulesAction>;
       }
 
       namespace Amendment {
@@ -2285,6 +2290,34 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'amendment_start' | 'automatic';
 
+        interface BillingSchedulesAction {
+          /**
+           * Specify which subscription items the billing schedule applies to.
+           */
+          applies_to?: Array<BillingSchedulesAction.AppliesTo>;
+
+          /**
+           * Select the action.
+           */
+          type: BillingSchedulesAction.Type;
+        }
+
+        namespace BillingSchedulesAction {
+          interface AppliesTo {
+            /**
+             * The ID of the price object.
+             */
+            price?: string;
+
+            /**
+             * Controls which subscription items the billing schedule applies to.
+             */
+            type: 'price';
+          }
+
+          type Type = 'remove' | 'set';
+        }
+
         interface DiscountAction {
           /**
            * Details of the discount to add.

package/types/Subscriptions.d.ts

@@ -364,19 +364,19 @@ declare module 'stripe' {
         applies_to: Array<BillingSchedule.AppliesTo> | null;
 
         /**
-         * Specifies the billing period.
+         * Specifies the start of the billing period.
          */
-        bill_until: BillingSchedule.BillUntil;
+        bill_from?: BillingSchedule.BillFrom | null;
 
         /**
-         * Unique identifier for the billing schedule.
+         * Specifies the end of billing period.
          */
-        key: string;
+        bill_until: BillingSchedule.BillUntil;
 
         /**
-         * Specifies the start of the billing period.
+         * Unique identifier for the billing schedule.
          */
-        bill_from?: BillingSchedule.BillFrom | null;
+        key: string;
       }
 
       namespace BillingSchedule {
@@ -466,6 +466,11 @@ declare module 'stripe' {
         }
 
         interface BillUntil {
+          /**
+           * Use an index to specify the position of an amendment to end prebilling with.
+           */
+          amendment_end?: BillUntil.AmendmentEnd | null;
+
           /**
            * The timestamp the billing schedule will apply until.
            */
@@ -476,6 +481,11 @@ declare module 'stripe' {
            */
           duration: BillUntil.Duration | null;
 
+          /**
+           * Lets you bill the period ending at a particular Quote line.
+           */
+          line_ends_at?: BillUntil.LineEndsAt | null;
+
           /**
            * If specified, the billing schedule will apply until the specified timestamp.
            */
@@ -485,16 +495,6 @@ declare module 'stripe' {
            * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
            */
           type: BillUntil.Type;
-
-          /**
-           * Use an index to specify the position of an amendment to end prebilling with.
-           */
-          amendment_end?: BillUntil.AmendmentEnd | null;
-
-          /**
-           * Lets you bill the period ending at a particular Quote line.
-           */
-          line_ends_at?: BillUntil.LineEndsAt | null;
         }
 
         namespace BillUntil {

package/types/Tax/Associations.d.ts

@@ -30,7 +30,7 @@ declare module 'stripe' {
         /**
          * Information about the tax transactions linked to this payment intent
          */
-        tax_transaction_attempts?: Array<
+        tax_transaction_attempts: Array<
           Association.TaxTransactionAttempt
         > | null;
       }

package/types/Tax/RegistrationsResource.d.ts

@@ -2338,7 +2338,7 @@ declare module 'stripe' {
           namespace Us {
             interface LocalAmusementTax {
               /**
-               * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
+               * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `02154` (Arlington Heights), `06613` (Bloomington), `10906` (Campton Hills), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
                */
               jurisdiction: string;
             }