stripe 18.5.0-beta.2 → 18.6.0-alpha.1

package/types/PaymentIntentsResource.d.ts

@@ -78,6 +78,13 @@ declare module 'stripe' {
        */
       error_on_requires_action?: boolean;
 
+      /**
+       * The list of payment method types to exclude from use with this payment.
+       */
+      excluded_payment_method_types?: Array<
+        PaymentIntentCreateParams.ExcludedPaymentMethodType
+      >;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -417,6 +424,63 @@ declare module 'stripe' {
 
       type ConfirmationMethod = 'automatic' | 'manual';
 
+      type ExcludedPaymentMethodType =
+        | 'acss_debit'
+        | 'affirm'
+        | 'afterpay_clearpay'
+        | 'alipay'
+        | 'alma'
+        | 'amazon_pay'
+        | 'au_becs_debit'
+        | 'bacs_debit'
+        | 'bancontact'
+        | 'billie'
+        | 'blik'
+        | 'boleto'
+        | 'card'
+        | 'cashapp'
+        | 'crypto'
+        | 'customer_balance'
+        | 'eps'
+        | 'fpx'
+        | 'giropay'
+        | 'gopay'
+        | 'grabpay'
+        | 'id_bank_transfer'
+        | 'ideal'
+        | 'kakao_pay'
+        | 'klarna'
+        | 'konbini'
+        | 'kr_card'
+        | 'mb_way'
+        | 'mobilepay'
+        | 'multibanco'
+        | 'naver_pay'
+        | 'nz_bank_account'
+        | 'oxxo'
+        | 'p24'
+        | 'pay_by_bank'
+        | 'payco'
+        | 'paynow'
+        | 'paypal'
+        | 'payto'
+        | 'pix'
+        | 'promptpay'
+        | 'qris'
+        | 'rechnung'
+        | 'revolut_pay'
+        | 'samsung_pay'
+        | 'satispay'
+        | 'sepa_debit'
+        | 'shopeepay'
+        | 'sofort'
+        | 'stripe_balance'
+        | 'swish'
+        | 'twint'
+        | 'us_bank_account'
+        | 'wechat_pay'
+        | 'zip';
+
       interface Hooks {
         /**
          * Arguments passed in automations
@@ -3966,6 +4030,11 @@ declare module 'stripe' {
         }
 
         interface Pix {
+          /**
+           * Determines if the amount includes the IOF tax. Defaults to `never`.
+           */
+          amount_includes_iof?: Pix.AmountIncludesIof;
+
           /**
            * The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
            */
@@ -3976,6 +4045,11 @@ declare module 'stripe' {
            */
           expires_at?: number;
 
+          /**
+           * Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
+           */
+          mandate_options?: Pix.MandateOptions;
+
           /**
            * Indicates that you intend to make future payments with this PaymentIntent's payment method.
            *
@@ -3987,7 +4061,68 @@ declare module 'stripe' {
            *
            * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
            */
-          setup_future_usage?: 'none';
+          setup_future_usage?: Pix.SetupFutureUsage;
+        }
+
+        namespace Pix {
+          type AmountIncludesIof = 'always' | 'never';
+
+          interface MandateOptions {
+            /**
+             * Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+             */
+            amount?: number;
+
+            /**
+             * Determines if the amount includes the IOF tax. Defaults to `never`.
+             */
+            amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+            /**
+             * Type of amount. Defaults to `maximum`.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+             */
+            currency?: string;
+
+            /**
+             * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+             */
+            end_date?: string;
+
+            /**
+             * Schedule at which the future payments will be charged. Defaults to `weekly`.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+             */
+            reference?: string;
+
+            /**
+             * Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountIncludesIof = 'always' | 'never';
+
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'halfyearly'
+              | 'monthly'
+              | 'quarterly'
+              | 'weekly'
+              | 'yearly';
+          }
+
+          type SetupFutureUsage = 'none' | 'off_session';
         }
 
         interface Promptpay {
@@ -8332,6 +8467,11 @@ declare module 'stripe' {
         }
 
         interface Pix {
+          /**
+           * Determines if the amount includes the IOF tax. Defaults to `never`.
+           */
+          amount_includes_iof?: Pix.AmountIncludesIof;
+
           /**
            * The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
            */
@@ -8342,6 +8482,11 @@ declare module 'stripe' {
            */
           expires_at?: number;
 
+          /**
+           * Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
+           */
+          mandate_options?: Pix.MandateOptions;
+
           /**
            * Indicates that you intend to make future payments with this PaymentIntent's payment method.
            *
@@ -8353,7 +8498,68 @@ declare module 'stripe' {
            *
            * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
            */
-          setup_future_usage?: 'none';
+          setup_future_usage?: Pix.SetupFutureUsage;
+        }
+
+        namespace Pix {
+          type AmountIncludesIof = 'always' | 'never';
+
+          interface MandateOptions {
+            /**
+             * Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+             */
+            amount?: number;
+
+            /**
+             * Determines if the amount includes the IOF tax. Defaults to `never`.
+             */
+            amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+            /**
+             * Type of amount. Defaults to `maximum`.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+             */
+            currency?: string;
+
+            /**
+             * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+             */
+            end_date?: string;
+
+            /**
+             * Schedule at which the future payments will be charged. Defaults to `weekly`.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+             */
+            reference?: string;
+
+            /**
+             * Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountIncludesIof = 'always' | 'never';
+
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'halfyearly'
+              | 'monthly'
+              | 'quarterly'
+              | 'weekly'
+              | 'yearly';
+          }
+
+          type SetupFutureUsage = 'none' | 'off_session';
         }
 
         interface Promptpay {
@@ -13686,6 +13892,11 @@ declare module 'stripe' {
         }
 
         interface Pix {
+          /**
+           * Determines if the amount includes the IOF tax. Defaults to `never`.
+           */
+          amount_includes_iof?: Pix.AmountIncludesIof;
+
           /**
            * The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
            */
@@ -13696,6 +13907,11 @@ declare module 'stripe' {
            */
           expires_at?: number;
 
+          /**
+           * Additional fields for mandate creation. Only applicable when `setup_future_usage=off_session`.
+           */
+          mandate_options?: Pix.MandateOptions;
+
           /**
            * Indicates that you intend to make future payments with this PaymentIntent's payment method.
            *
@@ -13707,7 +13923,68 @@ declare module 'stripe' {
            *
            * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
            */
-          setup_future_usage?: 'none';
+          setup_future_usage?: Pix.SetupFutureUsage;
+        }
+
+        namespace Pix {
+          type AmountIncludesIof = 'always' | 'never';
+
+          interface MandateOptions {
+            /**
+             * Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+             */
+            amount?: number;
+
+            /**
+             * Determines if the amount includes the IOF tax. Defaults to `never`.
+             */
+            amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+            /**
+             * Type of amount. Defaults to `maximum`.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+             */
+            currency?: string;
+
+            /**
+             * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+             */
+            end_date?: string;
+
+            /**
+             * Schedule at which the future payments will be charged. Defaults to `weekly`.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+             */
+            reference?: string;
+
+            /**
+             * Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountIncludesIof = 'always' | 'never';
+
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'halfyearly'
+              | 'monthly'
+              | 'quarterly'
+              | 'weekly'
+              | 'yearly';
+          }
+
+          type SetupFutureUsage = 'none' | 'off_session';
         }
 
         interface Promptpay {

package/types/PaymentLinksResource.d.ts

@@ -540,7 +540,7 @@ declare module 'stripe' {
         adjustable_quantity?: LineItem.AdjustableQuantity;
 
         /**
-         * The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
+         * The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
          */
         price?: string;
 

package/types/PaymentMethods.d.ts

@@ -97,6 +97,11 @@ declare module 'stripe' {
 
       kr_card?: PaymentMethod.KrCard;
 
+      /**
+       * The Mandate object of the most recently created Mandate associated with this payment method
+       */
+      latest_active_mandate?: Stripe.Mandate | null;
+
       link?: PaymentMethod.Link;
 
       /**

package/types/PaymentRecords.d.ts

@@ -19,6 +19,16 @@ declare module 'stripe' {
        */
       object: 'payment_record';
 
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount: PaymentRecord.Amount;
+
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_authorized: PaymentRecord.AmountAuthorized;
+
       /**
        * A representation of an amount of money, consisting of an amount and a currency.
        */
@@ -34,11 +44,21 @@ declare module 'stripe' {
        */
       amount_guaranteed: PaymentRecord.AmountGuaranteed;
 
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_refunded: PaymentRecord.AmountRefunded;
+
       /**
        * A representation of an amount of money, consisting of an amount and a currency.
        */
       amount_requested: PaymentRecord.AmountRequested;
 
+      /**
+       * ID of the Connect application that created the PaymentRecord.
+       */
+      application: string | null;
+
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
@@ -80,9 +100,9 @@ declare module 'stripe' {
       payment_method_details: PaymentRecord.PaymentMethodDetails | null;
 
       /**
-       * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+       * Processor information associated with this payment.
        */
-      payment_reference: string | null;
+      processor_details: PaymentRecord.ProcessorDetails;
 
       /**
        * Shipping information for this payment.
@@ -91,6 +111,30 @@ declare module 'stripe' {
     }
 
     namespace PaymentRecord {
+      interface Amount {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+         */
+        value: number;
+      }
+
+      interface AmountAuthorized {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+         */
+        value: number;
+      }
+
       interface AmountCanceled {
         /**
          * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -98,7 +142,7 @@ declare module 'stripe' {
         currency: string;
 
         /**
-         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
          */
         value: number;
       }
@@ -110,7 +154,7 @@ declare module 'stripe' {
         currency: string;
 
         /**
-         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
          */
         value: number;
       }
@@ -122,7 +166,19 @@ declare module 'stripe' {
         currency: string;
 
         /**
-         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+         */
+        value: number;
+      }
+
+      interface AmountRefunded {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
          */
         value: number;
       }
@@ -134,7 +190,7 @@ declare module 'stripe' {
         currency: string;
 
         /**
-         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) for example, 100 cents for 1 USD or 100 for 100 JPY, a zero-decimal currency.
+         * A positive integer representing the amount in the currency's [minor unit](https://stripe.com/docs/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
          */
         value: number;
       }
@@ -458,10 +514,31 @@ declare module 'stripe' {
           transaction_id: string | null;
         }
 
-        interface Alma {}
+        interface Alma {
+          installments?: Alma.Installments;
+
+          /**
+           * The Alma transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
+        }
+
+        namespace Alma {
+          interface Installments {
+            /**
+             * The number of installments.
+             */
+            count: number;
+          }
+        }
 
         interface AmazonPay {
           funding?: AmazonPay.Funding;
+
+          /**
+           * The Amazon Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         namespace AmazonPay {
@@ -606,7 +683,12 @@ declare module 'stripe' {
           type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
         }
 
-        interface Billie {}
+        interface Billie {
+          /**
+           * The Billie transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
+        }
 
         interface BillingDetails {
           /**
@@ -1467,6 +1549,11 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Kakao Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         interface Klarna {
@@ -1541,6 +1628,11 @@ declare module 'stripe' {
            * The last four digits of the card. This may not be present for American Express cards.
            */
           last4: string | null;
+
+          /**
+           * The Korean Card transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         namespace KrCard {
@@ -1632,6 +1724,11 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Naver Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         interface NzBankAccount {
@@ -1729,6 +1826,11 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Payco transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         interface Paynow {
@@ -1845,6 +1947,11 @@ declare module 'stripe' {
            * Unique transaction id generated by BCB
            */
           bank_transaction_id?: string | null;
+
+          /**
+           * ID of the multi use Mandate generated by the PaymentIntent
+           */
+          mandate?: string;
         }
 
         interface Promptpay {
@@ -1860,6 +1967,11 @@ declare module 'stripe' {
 
         interface RevolutPay {
           funding?: RevolutPay.Funding;
+
+          /**
+           * The Revolut Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         namespace RevolutPay {
@@ -1917,9 +2029,19 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Samsung Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
-        interface Satispay {}
+        interface Satispay {
+          /**
+           * The Satispay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
+        }
 
         interface SepaCreditTransfer {
           /**
@@ -2138,6 +2260,29 @@ declare module 'stripe' {
         interface Zip {}
       }
 
+      interface ProcessorDetails {
+        /**
+         * Custom processors represent payment processors not modeled directly in
+         * the Stripe API. This resource consists of details about the custom processor
+         * used for this payment attempt.
+         */
+        custom?: ProcessorDetails.Custom;
+
+        /**
+         * The processor used for this payment attempt.
+         */
+        type: 'custom';
+      }
+
+      namespace ProcessorDetails {
+        interface Custom {
+          /**
+           * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+           */
+          payment_reference: string;
+        }
+      }
+
       interface ShippingDetails {
         /**
          * A representation of a physical address.