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

package/types/PaymentRecordsResource.d.ts

@@ -66,9 +66,9 @@ declare module 'stripe' {
       outcome?: PaymentRecordReportPaymentParams.Outcome;
 
       /**
-       * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+       * Processor information for this payment.
        */
-      payment_reference?: string;
+      processor_details?: PaymentRecordReportPaymentParams.ProcessorDetails;
 
       /**
        * Shipping information for this payment.
@@ -84,7 +84,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;
       }
@@ -187,6 +187,27 @@ declare module 'stripe' {
         }
       }
 
+      interface ProcessorDetails {
+        /**
+         * Information about the custom processor used to make this payment.
+         */
+        custom?: ProcessorDetails.Custom;
+
+        /**
+         * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+         */
+        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 {
         /**
          * The physical shipping address.

package/types/Payouts.d.ts

@@ -115,7 +115,7 @@ declare module 'stripe' {
       /**
        * ID of the v2 FinancialAccount the funds are sent to.
        */
-      payout_method?: string | null;
+      payout_method: string | null;
 
       /**
        * If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.

package/types/PromotionCodes.d.ts

@@ -3,8 +3,11 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
-     * create multiple codes for a single coupon.
+     * A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons).
+     * You can create multiple codes for a single coupon.
+     *
+     * If you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
+     * Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.
      */
     interface PromotionCode {
       /**

package/types/QuotePreviewInvoices.d.ts

@@ -801,7 +801,7 @@ declare module 'stripe' {
         network_advice_code?: string;
 
         /**
-         * For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
+         * For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
          */
         network_decline_code?: string;
 
@@ -922,6 +922,7 @@ declare module 'stripe' {
           | 'coupon_expired'
           | 'customer_max_payment_methods'
           | 'customer_max_subscriptions'
+          | 'customer_session_expired'
           | 'customer_tax_location_invalid'
           | 'debit_not_authorized'
           | 'email_invalid'
@@ -940,6 +941,7 @@ declare module 'stripe' {
           | 'incorrect_cvc'
           | 'incorrect_number'
           | 'incorrect_zip'
+          | 'india_recurring_payment_mandate_canceled'
           | 'instant_payouts_config_disabled'
           | 'instant_payouts_currency_disabled'
           | 'instant_payouts_limit_exceeded'
@@ -1069,6 +1071,11 @@ declare module 'stripe' {
       }
 
       interface Parent {
+        /**
+         * Details about the billing cadence that generated this invoice
+         */
+        billing_cadence_details?: Parent.BillingCadenceDetails | null;
+
         /**
          * Details about the quote that generated this invoice
          */
@@ -1086,6 +1093,13 @@ declare module 'stripe' {
       }
 
       namespace Parent {
+        interface BillingCadenceDetails {
+          /**
+           * The billing cadence that generated this invoice
+           */
+          billing_cadence: string;
+        }
+
         interface QuoteDetails {
           /**
            * The quote that generated this invoice
@@ -1134,7 +1148,10 @@ declare module 'stripe' {
           }
         }
 
-        type Type = 'quote_details' | 'subscription_details';
+        type Type =
+          | 'billing_cadence_details'
+          | 'quote_details'
+          | 'subscription_details';
       }
 
       interface PaymentSettings {

package/types/QuotePreviewSubscriptionSchedules.d.ts

@@ -476,6 +476,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.
            */
@@ -528,6 +535,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/SetupAttempts.d.ts

@@ -133,6 +133,8 @@ declare module 'stripe' {
 
         payto?: PaymentMethodDetails.Payto;
 
+        pix?: PaymentMethodDetails.Pix;
+
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
@@ -530,6 +532,8 @@ declare module 'stripe' {
 
         interface Payto {}
 
+        interface Pix {}
+
         interface RevolutPay {}
 
         interface SepaDebit {}
@@ -624,7 +628,7 @@ declare module 'stripe' {
         network_advice_code?: string;
 
         /**
-         * For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
+         * For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
          */
         network_decline_code?: string;
 
@@ -745,6 +749,7 @@ declare module 'stripe' {
           | 'coupon_expired'
           | 'customer_max_payment_methods'
           | 'customer_max_subscriptions'
+          | 'customer_session_expired'
           | 'customer_tax_location_invalid'
           | 'debit_not_authorized'
           | 'email_invalid'
@@ -763,6 +768,7 @@ declare module 'stripe' {
           | 'incorrect_cvc'
           | 'incorrect_number'
           | 'incorrect_zip'
+          | 'india_recurring_payment_mandate_canceled'
           | 'instant_payouts_config_disabled'
           | 'instant_payouts_currency_disabled'
           | 'instant_payouts_limit_exceeded'

package/types/SetupIntents.d.ts

@@ -232,7 +232,7 @@ declare module 'stripe' {
         network_advice_code?: string;
 
         /**
-         * For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
+         * For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
          */
         network_decline_code?: string;
 
@@ -353,6 +353,7 @@ declare module 'stripe' {
           | 'coupon_expired'
           | 'customer_max_payment_methods'
           | 'customer_max_subscriptions'
+          | 'customer_session_expired'
           | 'customer_tax_location_invalid'
           | 'debit_not_authorized'
           | 'email_invalid'
@@ -371,6 +372,7 @@ declare module 'stripe' {
           | 'incorrect_cvc'
           | 'incorrect_number'
           | 'incorrect_zip'
+          | 'india_recurring_payment_mandate_canceled'
           | 'instant_payouts_config_disabled'
           | 'instant_payouts_currency_disabled'
           | 'instant_payouts_limit_exceeded'
@@ -502,6 +504,8 @@ declare module 'stripe' {
       interface NextAction {
         cashapp_handle_redirect_or_display_qr_code?: NextAction.CashappHandleRedirectOrDisplayQrCode;
 
+        pix_display_qr_code?: NextAction.PixDisplayQrCode;
+
         redirect_to_url?: NextAction.RedirectToUrl;
 
         /**
@@ -551,6 +555,33 @@ declare module 'stripe' {
           }
         }
 
+        interface PixDisplayQrCode {
+          /**
+           * The raw data string used to generate QR code, it should be used together with QR code library.
+           */
+          data?: string;
+
+          /**
+           * The date (unix timestamp) when the PIX expires.
+           */
+          expires_at?: number;
+
+          /**
+           * The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
+           */
+          hosted_instructions_url?: string;
+
+          /**
+           * The image_url_png string used to render png QR code
+           */
+          image_url_png?: string;
+
+          /**
+           * The image_url_svg string used to render svg QR code
+           */
+          image_url_svg?: string;
+        }
+
         interface RedirectToUrl {
           /**
            * If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
@@ -618,6 +649,8 @@ declare module 'stripe' {
 
         payto?: PaymentMethodOptions.Payto;
 
+        pix?: PaymentMethodOptions.Pix;
+
         sepa_debit?: PaymentMethodOptions.SepaDebit;
 
         us_bank_account?: PaymentMethodOptions.UsBankAccount;
@@ -897,6 +930,67 @@ declare module 'stripe' {
           }
         }
 
+        interface Pix {
+          mandate_options?: Pix.MandateOptions;
+        }
+
+        namespace Pix {
+          interface MandateOptions {
+            /**
+             * Amount to be charged for future payments.
+             */
+            amount?: number;
+
+            /**
+             * Determines if the amount includes the IOF tax.
+             */
+            amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+            /**
+             * Type of amount.
+             */
+            amount_type?: MandateOptions.AmountType;
+
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+             */
+            currency?: string;
+
+            /**
+             * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+             */
+            end_date?: string;
+
+            /**
+             * Schedule at which the future payments will be charged.
+             */
+            payment_schedule?: MandateOptions.PaymentSchedule;
+
+            /**
+             * Subscription name displayed to buyers in their bank app.
+             */
+            reference?: string;
+
+            /**
+             * Start date of the mandate, in `YYYY-MM-DD`.
+             */
+            start_date?: string;
+          }
+
+          namespace MandateOptions {
+            type AmountIncludesIof = 'always' | 'never';
+
+            type AmountType = 'fixed' | 'maximum';
+
+            type PaymentSchedule =
+              | 'halfyearly'
+              | 'monthly'
+              | 'quarterly'
+              | 'weekly'
+              | 'yearly';
+          }
+        }
+
         interface SepaDebit {
           mandate_options?: SepaDebit.MandateOptions;
         }

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 {