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

package/types/SetupIntentsResource.d.ts

@@ -1095,6 +1095,11 @@ declare module 'stripe' {
          */
         payto?: PaymentMethodOptions.Payto;
 
+        /**
+         * If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
+         */
+        pix?: PaymentMethodOptions.Pix;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -1624,6 +1629,70 @@ declare module 'stripe' {
           }
         }
 
+        interface Pix {
+          /**
+           * Additional fields for mandate creation.
+           */
+          mandate_options?: Pix.MandateOptions;
+        }
+
+        namespace Pix {
+          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';
+          }
+        }
+
         interface SepaDebit {
           /**
            * Additional fields for Mandate creation
@@ -2757,6 +2826,11 @@ declare module 'stripe' {
          */
         payto?: PaymentMethodOptions.Payto;
 
+        /**
+         * If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
+         */
+        pix?: PaymentMethodOptions.Pix;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -3286,6 +3360,70 @@ declare module 'stripe' {
           }
         }
 
+        interface Pix {
+          /**
+           * Additional fields for mandate creation.
+           */
+          mandate_options?: Pix.MandateOptions;
+        }
+
+        namespace Pix {
+          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';
+          }
+        }
+
         interface SepaDebit {
           /**
            * Additional fields for Mandate creation
@@ -4466,6 +4604,11 @@ declare module 'stripe' {
          */
         payto?: PaymentMethodOptions.Payto;
 
+        /**
+         * If this is a `pix` SetupIntent, this sub-hash contains details about the Pix payment method options.
+         */
+        pix?: PaymentMethodOptions.Pix;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -4995,6 +5138,70 @@ declare module 'stripe' {
           }
         }
 
+        interface Pix {
+          /**
+           * Additional fields for mandate creation.
+           */
+          mandate_options?: Pix.MandateOptions;
+        }
+
+        namespace Pix {
+          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';
+          }
+        }
+
         interface SepaDebit {
           /**
            * Additional fields for Mandate creation

package/types/SubscriptionSchedules.d.ts

@@ -455,6 +455,13 @@ declare module 'stripe' {
            */
           discounts: Array<AddInvoiceItem.Discount>;
 
+          /**
+           * Set of [key-value pairs](https://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: Stripe.Metadata | null;
+
+          period: AddInvoiceItem.Period;
+
           /**
            * ID of the price used to generate the invoice item.
            */
@@ -507,6 +514,46 @@ declare module 'stripe' {
               type: 'timestamp';
             }
           }
+
+          interface Period {
+            end: Period.End;
+
+            start: Period.Start;
+          }
+
+          namespace Period {
+            interface End {
+              /**
+               * A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
+               */
+              timestamp?: number;
+
+              /**
+               * Select how to calculate the end of the invoice item period.
+               */
+              type: End.Type;
+            }
+
+            namespace End {
+              type Type = 'min_item_period_end' | 'phase_end' | 'timestamp';
+            }
+
+            interface Start {
+              /**
+               * A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
+               */
+              timestamp?: number;
+
+              /**
+               * Select how to calculate the start of the invoice item period.
+               */
+              type: Start.Type;
+            }
+
+            namespace Start {
+              type Type = 'max_item_period_start' | 'phase_start' | 'timestamp';
+            }
+          }
         }
 
         interface AutomaticTax {

package/types/SubscriptionSchedulesResource.d.ts

@@ -363,6 +363,16 @@ declare module 'stripe' {
            */
           discounts?: Array<AddInvoiceItem.Discount>;
 
+          /**
+           * Set of [key-value pairs](https://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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+           */
+          metadata?: Stripe.MetadataParam;
+
+          /**
+           * The period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.
+           */
+          period?: AddInvoiceItem.Period;
+
           /**
            * The ID of the price object. One of `price` or `price_data` is required.
            */
@@ -446,6 +456,52 @@ declare module 'stripe' {
             }
           }
 
+          interface Period {
+            /**
+             * End of the invoice item period.
+             */
+            end: Period.End;
+
+            /**
+             * Start of the invoice item period.
+             */
+            start: Period.Start;
+          }
+
+          namespace Period {
+            interface End {
+              /**
+               * A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
+               */
+              timestamp?: number;
+
+              /**
+               * Select how to calculate the end of the invoice item period.
+               */
+              type: End.Type;
+            }
+
+            namespace End {
+              type Type = 'min_item_period_end' | 'phase_end' | 'timestamp';
+            }
+
+            interface Start {
+              /**
+               * A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
+               */
+              timestamp?: number;
+
+              /**
+               * Select how to calculate the start of the invoice item period.
+               */
+              type: Start.Type;
+            }
+
+            namespace Start {
+              type Type = 'max_item_period_start' | 'phase_start' | 'timestamp';
+            }
+          }
+
           interface PriceData {
             /**
              * 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).
@@ -1231,6 +1287,16 @@ declare module 'stripe' {
            */
           discounts?: Array<AddInvoiceItem.Discount>;
 
+          /**
+           * Set of [key-value pairs](https://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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+           */
+          metadata?: Stripe.MetadataParam;
+
+          /**
+           * The period associated with this invoice item. Defaults to the period of the underlying subscription that surrounds the start of the phase.
+           */
+          period?: AddInvoiceItem.Period;
+
           /**
            * The ID of the price object. One of `price` or `price_data` is required.
            */
@@ -1314,6 +1380,52 @@ declare module 'stripe' {
             }
           }
 
+          interface Period {
+            /**
+             * End of the invoice item period.
+             */
+            end: Period.End;
+
+            /**
+             * Start of the invoice item period.
+             */
+            start: Period.Start;
+          }
+
+          namespace Period {
+            interface End {
+              /**
+               * A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
+               */
+              timestamp?: number;
+
+              /**
+               * Select how to calculate the end of the invoice item period.
+               */
+              type: End.Type;
+            }
+
+            namespace End {
+              type Type = 'min_item_period_end' | 'phase_end' | 'timestamp';
+            }
+
+            interface Start {
+              /**
+               * A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
+               */
+              timestamp?: number;
+
+              /**
+               * Select how to calculate the start of the invoice item period.
+               */
+              type: Start.Type;
+            }
+
+            namespace Start {
+              type Type = 'max_item_period_start' | 'phase_start' | 'timestamp';
+            }
+          }
+
           interface PriceData {
             /**
              * 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).

package/types/SubscriptionsResource.d.ts

@@ -205,6 +205,16 @@ declare module 'stripe' {
          */
         discounts?: Array<AddInvoiceItem.Discount>;
 
+        /**
+         * Set of [key-value pairs](https://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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * The period associated with this invoice item. Defaults to the current period of the subscription.
+         */
+        period?: AddInvoiceItem.Period;
+
         /**
          * The ID of the price object. One of `price` or `price_data` is required.
          */
@@ -288,6 +298,52 @@ declare module 'stripe' {
           }
         }
 
+        interface Period {
+          /**
+           * End of the invoice item period.
+           */
+          end: Period.End;
+
+          /**
+           * Start of the invoice item period.
+           */
+          start: Period.Start;
+        }
+
+        namespace Period {
+          interface End {
+            /**
+             * A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
+             */
+            timestamp?: number;
+
+            /**
+             * Select how to calculate the end of the invoice item period.
+             */
+            type: End.Type;
+          }
+
+          namespace End {
+            type Type = 'min_item_period_end' | 'timestamp';
+          }
+
+          interface Start {
+            /**
+             * A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
+             */
+            timestamp?: number;
+
+            /**
+             * Select how to calculate the start of the invoice item period.
+             */
+            type: Start.Type;
+          }
+
+          namespace Start {
+            type Type = 'max_item_period_start' | 'now' | 'timestamp';
+          }
+        }
+
         interface PriceData {
           /**
            * 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).
@@ -352,27 +408,27 @@ declare module 'stripe' {
 
       interface BillingCycleAnchorConfig {
         /**
-         * The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
+         * The day of the month the anchor should be. Ranges from 1 to 31.
          */
         day_of_month: number;
 
         /**
-         * The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
+         * The hour of the day the anchor should be. Ranges from 0 to 23.
          */
         hour?: number;
 
         /**
-         * The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
+         * The minute of the hour the anchor should be. Ranges from 0 to 59.
          */
         minute?: number;
 
         /**
-         * The month to start full cycle billing periods. Ranges from 1 to 12.
+         * The month to start full cycle periods. Ranges from 1 to 12.
          */
         month?: number;
 
         /**
-         * The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
+         * The second of the minute the anchor should be. Ranges from 0 to 59.
          */
         second?: number;
       }
@@ -1298,6 +1354,16 @@ declare module 'stripe' {
          */
         discounts?: Array<AddInvoiceItem.Discount>;
 
+        /**
+         * Set of [key-value pairs](https://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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * The period associated with this invoice item. Defaults to the current period of the subscription.
+         */
+        period?: AddInvoiceItem.Period;
+
         /**
          * The ID of the price object. One of `price` or `price_data` is required.
          */
@@ -1381,6 +1447,52 @@ declare module 'stripe' {
           }
         }
 
+        interface Period {
+          /**
+           * End of the invoice item period.
+           */
+          end: Period.End;
+
+          /**
+           * Start of the invoice item period.
+           */
+          start: Period.Start;
+        }
+
+        namespace Period {
+          interface End {
+            /**
+             * A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
+             */
+            timestamp?: number;
+
+            /**
+             * Select how to calculate the end of the invoice item period.
+             */
+            type: End.Type;
+          }
+
+          namespace End {
+            type Type = 'min_item_period_end' | 'timestamp';
+          }
+
+          interface Start {
+            /**
+             * A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
+             */
+            timestamp?: number;
+
+            /**
+             * Select how to calculate the start of the invoice item period.
+             */
+            type: Start.Type;
+          }
+
+          namespace Start {
+            type Type = 'max_item_period_start' | 'now' | 'timestamp';
+          }
+        }
+
         interface PriceData {
           /**
            * 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).
@@ -2218,12 +2330,12 @@ declare module 'stripe' {
       created?: Stripe.RangeQueryParam | number;
 
       /**
-       * Only return subscriptions whose current_period_end falls within the given date interval.
+       * Only return subscriptions whose minimum item current_period_end falls within the given date interval.
        */
       current_period_end?: Stripe.RangeQueryParam | number;
 
       /**
-       * Only return subscriptions whose current_period_start falls within the given date interval.
+       * Only return subscriptions whose maximum item current_period_start falls within the given date interval.
        */
       current_period_start?: Stripe.RangeQueryParam | number;
 

package/types/Terminal/Configurations.d.ts

@@ -42,6 +42,8 @@ declare module 'stripe' {
 
         offline?: Configuration.Offline;
 
+        reader_security?: Configuration.ReaderSecurity;
+
         reboot_window?: Configuration.RebootWindow;
 
         stripe_s700?: Configuration.StripeS700;
@@ -68,6 +70,13 @@ declare module 'stripe' {
           enabled: boolean | null;
         }
 
+        interface ReaderSecurity {
+          /**
+           * Passcode used to access a reader's admin menu.
+           */
+          admin_menu_passcode: string;
+        }
+
         interface RebootWindow {
           /**
            * Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
@@ -112,6 +121,8 @@ declare module 'stripe' {
 
           jpy?: Tipping.Jpy;
 
+          mxn?: Tipping.Mxn;
+
           myr?: Tipping.Myr;
 
           nok?: Tipping.Nok;
@@ -334,6 +345,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Mxn {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts?: Array<number> | null;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages?: Array<number> | null;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Myr {
             /**
              * Fixed amounts displayed when collecting a tip